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

Add changelog for Airbyte Protocol #16560

Merged
merged 4 commits into from
Sep 12, 2022
Merged

Add changelog for Airbyte Protocol #16560

merged 4 commits into from
Sep 12, 2022

Conversation

evantahler
Copy link
Contributor

@evantahler evantahler commented Sep 9, 2022

Closes #15465 and referenced via #16479 (review)

This PR adds a human-readable changelog to the Airbyte Protocol. I did some git spelunking on the changes to airbyte_protocol.yaml to build this up. Let me know if I've missed any important steps in the history.

This PR differs slightly from the proposal in the PRD, adding a historical entry for oAuth, stream namespaces, and message.stack_trace

@github-actions github-actions bot added area/documentation Improvements or additions to documentation area/platform issues related to the platform area/protocol labels Sep 9, 2022
@evantahler evantahler temporarily deployed to more-secrets September 9, 2022 21:19 Inactive
@evantahler evantahler temporarily deployed to more-secrets September 9, 2022 21:19 Inactive
| 0.2.0 | 2022-06-10 | [13573](https://github.com/airbytehq/airbyte/pull/13573) and [12586](https://github.com/airbytehq/airbyte/pull/12586) | `STREAM` and `GLOBAL` STATE messages |
| 0.1.1 | 2022-06-06 | [13356](https://github.com/airbytehq/airbyte/pull/13356) | Add a namespace in association with the stream name |
| 0.1.0 | 2022-05-03 | [12458](https://github.com/airbytehq/airbyte/pull/12458) and [12581](https://github.com/airbytehq/airbyte/pull/12581) | `AirbyteTraceMessage` added to allow connectors to better communicate exceptions |
| 0.0.2 | 2021-11-15 | [7798](https://github.com/airbytehq/airbyte/pull/7798) | Support oAuth Connectors (internal) |
Copy link
Contributor Author

Choose a reason for hiding this comment

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

There were quite a few oAuth PRs... I picked this one to be the "main change"

| 0.1.0 | 2022-05-03 | [12458](https://github.com/airbytehq/airbyte/pull/12458) and [12581](https://github.com/airbytehq/airbyte/pull/12581) | `AirbyteTraceMessage` added to allow connectors to better communicate exceptions |
| 0.0.2 | 2021-11-15 | [7798](https://github.com/airbytehq/airbyte/pull/7798) | Support oAuth Connectors (internal) |
| 0.0.1 | 2021-11-19 | [1021](https://github.com/airbytehq/airbyte/pull/1021) | Remove sub-JSONSchemas |
| 0.0.0 | 2020-11-18 | [998](https://github.com/airbytehq/airbyte/pull/998) | Initial version described via JSON Schema |
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 used the PR in which the first version of the file that is now airbyte-protocol.yaml appeard.

@@ -1,29 +1,49 @@
# Airbyte Protocol
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 used a linter to format this file...

docs/understanding-airbyte/airbyte-protocol.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sherifnada sherifnada left a comment

Choose a reason for hiding this comment

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

saucy

@evantahler evantahler marked this pull request as ready for review September 9, 2022 22:08
@evantahler evantahler requested a review from a team as a code owner September 9, 2022 22:08
@evantahler evantahler temporarily deployed to more-secrets September 9, 2022 22:10 Inactive
@evantahler evantahler temporarily deployed to more-secrets September 9, 2022 22:10 Inactive
Copy link
Contributor

@gosusnp gosusnp left a comment

Choose a reason for hiding this comment

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

LGTM, I think we should bump to 0.3.0 instead of 0.2.1. Not feeling super strongly about it since we may still be back-filling some non-breaking versions here.

docs/understanding-airbyte/airbyte-protocol.md Outdated Show resolved Hide resolved
@evantahler evantahler merged commit 8cf60e4 into master Sep 12, 2022
@evantahler evantahler deleted the evan/protocol-changelog branch September 12, 2022 17:30
@evantahler
Copy link
Contributor Author

Airbyte Protocol Changelog is up! https://docs.airbyte.com/understanding-airbyte/airbyte-protocol#changelog

robbinhan pushed a commit to robbinhan/airbyte that referenced this pull request Sep 29, 2022
* Add changelog for Airbyte Protocol

* we are on v0.3.0 now
jhammarstedt pushed a commit to jhammarstedt/airbyte that referenced this pull request Oct 31, 2022
* Add changelog for Airbyte Protocol

* we are on v0.3.0 now
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation area/platform issues related to the platform area/protocol
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Airbyte Users can see a changelog for the Airbyte Protocol (docs page)
3 participants