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

docs: add v3.3.0 changelog entries #1468

Closed
wants to merge 6 commits into from

Conversation

MSalopek
Copy link
Contributor

@MSalopek MSalopek commented Dec 4, 2023

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...

  • included the correct docs: prefix in the PR title
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers 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...

  • Confirmed the correct docs: prefix in the PR title
  • Confirmed all author checklist items have been addressed
  • Confirmed that this PR only changes documentation
  • Reviewed content for consistency
  • Reviewed content for spelling and grammar
  • Tested instructions (if applicable)
  • Checked that the documentation website can be built and deployed successfully (run make build-docs)

@MSalopek MSalopek requested a review from a team as a code owner December 4, 2023 11:58
@MSalopek MSalopek self-assigned this Dec 4, 2023
@@ -0,0 +1,17 @@
*December 4th, 2023*
Copy link
Contributor

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.

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 added the release highlights, I can remove them but they do no harm.

Copy link
Contributor

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

Copy link
Contributor

@p-offtermatt p-offtermatt left a 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/v3.3.0/summary.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated

*December 4th, 2023*

This release is state and api reaking.
Copy link
Contributor

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

@MSalopek
Copy link
Contributor Author

MSalopek commented Dec 4, 2023

Linter failing is fine, it complains about uintPtr helper function from e2e tests - this is an artifact left over from removing provider throttling v2 changes.

Copy link
Contributor

@mpoke mpoke left a 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)
```

See https://github.com/cosmos/interchain-security/blob/main/RELEASE_PROCESS.md#creating-a-new-release-branch

@MSalopek
Copy link
Contributor Author

MSalopek commented Dec 4, 2023

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)

See https://github.com/cosmos/interchain-security/blob/main/RELEASE_PROCESS.md#creating-a-new-release-branch

You mean, we need to have v3.2.0, v3.1.0, v3.0.0 and previous versions?

EDIT:
I just made it contain text below since that's whats in the releasing docs.

[CHANGELOG of previous versions](https://github.com/cosmos/interchain-security/blob/main/CHANGELOG.md)

EDIT 2:
I now see that epilogue.md gets added to the bottom of the CHANGELOG.md, that's why the initial statement works - that was not obvious.

@MSalopek MSalopek requested a review from mpoke December 4, 2023 17:08
@MSalopek
Copy link
Contributor Author

MSalopek commented Dec 5, 2023

Closing in favor of #1476

@MSalopek MSalopek closed this Dec 5, 2023
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.

3 participants