Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📖 Added section to docs about the /publish command #11739

Merged
merged 27 commits into from
Apr 6, 2022
Merged
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
a471823
using yq + more success/failure comments
Phlair Apr 4, 2022
4f69469
added gradle process + git push
Phlair Apr 4, 2022
8165b6e
Merge branch 'master' into george/auto-version-bump
Phlair Apr 4, 2022
59c8d0a
dummy bump to test publish
Phlair Apr 4, 2022
a6e1c97
dummy bump to test publish
Phlair Apr 4, 2022
00d6d01
dummy bump to test publish
Phlair Apr 4, 2022
69c3e9d
bump version
Phlair Apr 4, 2022
29ac307
fix connector variable
Phlair Apr 4, 2022
da3fe5a
bump version
Phlair Apr 4, 2022
0cffdb0
Merge commit 'da3fe5a7cb5097383f7a770ac54fec7a3088cedb' into george/a…
Phlair Apr 4, 2022
45437a5
only git add necessary files
Phlair Apr 4, 2022
0b13dc3
remove git config
Phlair Apr 4, 2022
7c30b1a
bump version
Phlair Apr 4, 2022
3d3ccec
Merge branch 'george/auto-bumper' into george/auto-bumperrr
Phlair Apr 4, 2022
d3e6f91
making octavia user
Phlair Apr 4, 2022
10dbe53
version bump
Phlair Apr 4, 2022
11d3220
auto-bump connector version
octavia-squidington-iii Apr 4, 2022
9f60760
added docs and auto-bumo flag
Phlair Apr 5, 2022
0216753
Merge branch 'george/auto-bumperrr' of https://github.com/airbytehq/a…
Phlair Apr 5, 2022
16a1dde
bump version
Phlair Apr 5, 2022
c8dc496
separate IMAGE_NAME and IMAGE_VERSION env vars from sentry prep
Phlair Apr 5, 2022
dbf3f5b
version bump
Phlair Apr 5, 2022
e98019a
auto-bump connector version
octavia-squidington-iii Apr 5, 2022
7af9c96
Merge branch 'master' into george/auto-bumperrr
Phlair Apr 5, 2022
dbcfb70
added entry to apify changelog for clarity
Phlair Apr 5, 2022
5dec11d
Merge branch 'master' into george/auto-bumperrr
Phlair Apr 5, 2022
050073a
added details on /publish command
Phlair Apr 5, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/connector-development/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,16 @@ Once you've finished iterating on the changes to a connector as specified in its

5. The new version of the connector is now available for everyone who uses it. Thank you!

### The /publish command

Publishing a connector can be done using the `/publish` command as outlined in the above section. The command runs a [github workflow](https://github.com/airbytehq/airbyte/actions/workflows/publish-command.yml), and has the following configurable parameters:
* **connector** - Required. This tells the workflow which connector to publish. e.g. `connector=connectors/source-amazon-ads`
* **repo** - Defaults to the main airbyte repo. Set this when building connectors from forked repos. e.g. `repo=userfork/airbyte`
* **gitref** - Defaults to the branch of the PR where the /publish command is run as a comment. If running manually, set this to your branch where you made changes e.g. `gitref=george/s3-update`
* **run-tests** - Defaults to true. Should always run the tests as part of the publish flow so that if tests fail, the connector is not published.
* **comment-id** - This is automatically filled if you run /publish from a comment and enables the workflow to write back success/fail logs to the git comment.
* **auto-bump-version** - Defaults to true, automates the post-publish process of bumping the connector's version in the yaml seed definitions and generating spec.

## Using credentials in CI

In order to run integration tests in CI, you'll often need to inject credentials into CI. There are a few steps for doing this:
Expand Down