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.

Sign up for GitHub

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

Jump to bottom

📖 Add clarity on automatic version bump in docs / PR checklist #11813

Merged
merged 1 commit into from
Apr 7, 2022
Merged

📖 Add clarity on automatic version bump in docs / PR checklist #11813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,7 @@ If this is a community PR, the Airbyte engineer reviewing this PR is responsible
- [ ] Build is successful
- [ ] If new credentials are required for use in CI, add them to GSM. [Instructions](https://docs.airbyte.io/connector-development#using-credentials-in-ci).
- [ ] [`/test connector=connectors/<name>` command](https://docs.airbyte.io/connector-development#updating-an-existing-connector) is passing
- [ ] New Connector version released on Dockerhub by running the `/publish` command described [here](https://docs.airbyte.io/connector-development#updating-an-existing-connector)
- [ ] After the new connector version is published, connector version bumped in the seed directory as described [here](https://docs.airbyte.io/connector-development#publishing-a-connector)
- [ ] Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described [here](https://docs.airbyte.io/connector-development#publishing-a-connector)
- [ ] New Connector version released on Dockerhub and connector version bumped by running the `/publish` command described [here](https://docs.airbyte.io/connector-development#updating-an-existing-connector)

</details>

Expand Down
4 changes: 2 additions & 2 deletions docs/connector-development/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ Once you've finished iterating on the changes to a connector as specified in its
/publish connector=(connectors|bases)/<connector_name>
```

4. OPTIONAL: Only necessary if the automated connector version bump fails
* Update the connector definition in the Airbyte connector index to use the new version:
4. OPTIONAL: Necessary if this is a new connector, or the automated connector version bump fails
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if the bump fails, that fails the entire /publish command right? I.e. you'd have to rerun /publish, at which point it would try to bump again?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kept the flow the same order as before, so first it publishes the connector and if that succeeds, it then does the auto version bump.

That means it can successfully publish but then fail auto-bump, this shouldn't happen so if it does, manual eyes figuring out why is a good thing. This should be clear based on the comments that get added back to the git comment.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ah nice, makes sense 👍

* Update/Add the connector definition in the Airbyte connector index to use the new version:
* `airbyte-config/init/src/main/resources/seed/source_definitions.yaml` if it is a source
* `airbyte-config/init/src/main/resources/seed/destination_definitions.yaml` if it is a destination.

Expand Down