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

CESQL v1 release notes #1298

Merged
merged 4 commits into from
Jun 17, 2024
Merged

Conversation

Cali0707
Copy link
Contributor

Proposed Changes

  • Add release notes for CESQL v1
  • Link to release notes in RELEASES.md
  • Align RELEASES.md table

@Cali0707
Copy link
Contributor Author

cc @duglin

docs/RELEASES.md Outdated
| CloudEvents | [0.3](https://github.com/cloudevents/spec/tree/v0.3) | 2019/06/13 | [Notes](../cloudevents/RELEASE_NOTES.md#v03---20190613) |
| CloudEvents | [0.2](https://github.com/cloudevents/spec/tree/v0.2) | 2018/12/06 | [Notes](../cloudevents/RELEASE_NOTES.md#v02---20181206) |
| CloudEvents | [0.1](https://github.com/cloudevents/spec/tree/v0.1) | 2018/04/20 | [Notes](../cloudevents/RELEASE_NOTES.md#v01---20180420) |
| CESQL | 1.0 | 2024/06/13 | [Notes](../cesql/RELEASE_NOTES.md#v100---20240613) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

let's go ahead and order these by release date rather than Group. I'm thinking about the worse case scenario where we have, say, 100 entries across 3 groups... it would be kind of annoying for people to have to scroll a ton just to see the latest version of the last group listed.

@Cali0707 Cali0707 requested a review from duglin June 13, 2024 18:54
docs/RELEASES.md Outdated
| CloudEvents | [0.1](https://github.com/cloudevents/spec/tree/v0.1) | 2018/04/20 | [Notes](../cloudevents/RELEASE_NOTES.md#v01---20180420) |
| Specification Group | Version | Release Date | Release Notes |
| :------------------ | :------------------------------------------------------------------: | :----------- | :------------------------------------------------------: |
| CESQL | 1.0 | 2024/06/13 | [Notes](../cesql/RELEASE_NOTES.md#v100---20240613) |
Copy link
Collaborator

Choose a reason for hiding this comment

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

let's make 1.0 a link to: https://github.com/cloudevents/spec/tree/cesql/v1.0.0
the link checker will fail until we create the new release/branch but that's ok

@duglin
Copy link
Collaborator

duglin commented Jun 14, 2024

I forgot one more file: https://github.com/cloudevents/spec/blob/main/README.md update the table to reference v1.0.0 with a link to: https://github.com/cloudevents/spec/tree/cesql/v1.0.0/cesql
We should also update the README.md in the cesql to have more than just a link to the spec - just a short paragraph (even stolen from the spec) will be good enough for now

* Add link to cesql v1 in releases table
* Add short paragraph to cesql README

Signed-off-by: Calum Murray <[email protected]>
@Cali0707 Cali0707 requested a review from duglin June 17, 2024 13:29
@Cali0707
Copy link
Contributor Author

Sorry for the delay @duglin - I think everything should be correct now

@duglin
Copy link
Collaborator

duglin commented Jun 17, 2024

Merging!

@duglin duglin merged commit 82c16f6 into cloudevents:main Jun 17, 2024
1 of 2 checks passed
duglin pushed a commit to duglin/spec that referenced this pull request Jun 17, 2024
* docs: add release note for CESQL v1

Signed-off-by: Calum Murray <[email protected]>

* docs: add link to cesql v1 release notes to RELEASES.md

Signed-off-by: Calum Murray <[email protected]>

* fix: order by release date instead of group

Signed-off-by: Calum Murray <[email protected]>

* Address review comments

* Add link to cesql v1 in releases table
* Add short paragraph to cesql README

Signed-off-by: Calum Murray <[email protected]>

---------

Signed-off-by: Calum Murray <[email protected]>
Signed-off-by: Doug Davis <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants