-
Notifications
You must be signed in to change notification settings - Fork 147
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
docs: add v3.3.0 changelog entries #1468
Conversation
@@ -0,0 +1,17 @@ | |||
*December 4th, 2023* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The date is enough for a summary. Info on the release should go in the release notes.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added the release highlights, I can remove them but they do no harm.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just want to keep things simple and have release highlights in the release notes, while the changelog contains a list of relevant changes. Not that important though
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One typo, but approval otherwise.
CHANGELOG.md
Outdated
|
||
*December 4th, 2023* | ||
|
||
This release is state and api reaking. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regenerate this after fixing summary.md
Linter failing is fine, it complains about |
5e528be
to
2e4914b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Update the .changelog/epilogue.md
file to only contain the v3.1.0
and v3.0.0
sections followed by
```md
## Previous Versions
[CHANGELOG of previous versions](https://github.com/cosmos/interchain-security/blob/main/CHANGELOG.md)
```
You mean, we need to have EDIT:
EDIT 2: |
Closing in favor of #1476 |
Description
Closes: #XXXX
Add changelog file and cleanup entries.
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
docs:
prefix in the PR titleReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
I have...
docs:
prefix in the PR titlemake build-docs
)