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

ci: add changelog reminder #15459

Merged
merged 11 commits into from
Mar 21, 2023
Merged

ci: add changelog reminder #15459

merged 11 commits into from
Mar 21, 2023

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Mar 20, 2023

Description

Intermediary solution for: #15415
Replaces #15452.

Adding the git cliff config, as it is still useful, for some modules after cleaning up, we should not replace the current process, but this allows us to quickly fix the severely outdated changelog (like math).


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 type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation 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 type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@julienrbrt julienrbrt changed the title ci: add changelog reminder feat: add changelog reminder Mar 20, 2023
@julienrbrt julienrbrt marked this pull request as ready for review March 20, 2023 10:31
@julienrbrt julienrbrt requested a review from a team as a code owner March 20, 2023 10:31
@github-prbot github-prbot requested review from a team, JeancarloBarrios and tac0turtle and removed request for a team March 20, 2023 10:32
@julienrbrt
Copy link
Member Author

julienrbrt commented Mar 20, 2023

Don't merge yet, I am still testing.

R4R. Updated severely outdated changelog with command like npx git-cliff@latest --include-path "math/**/*.go" --output math/CHANGELOG.md

@github-actions
Copy link
Contributor

@julienrbrt your pull request is missing a changelog!

@julienrbrt julienrbrt changed the title feat: add changelog reminder ci: add changelog reminder Mar 20, 2023
@julienrbrt julienrbrt closed this Mar 20, 2023
@julienrbrt julienrbrt reopened this Mar 20, 2023
@github-prbot github-prbot requested a review from a team March 20, 2023 10:36
@julienrbrt julienrbrt marked this pull request as draft March 20, 2023 10:44
@julienrbrt julienrbrt marked this pull request as ready for review March 20, 2023 11:09
@github-prbot github-prbot requested review from a team, aaronc and alexanderbez and removed request for a team March 20, 2023 11:10
@julienrbrt julienrbrt changed the title ci: add changelog reminder incorrect: add changelog reminder Mar 20, 2023
@julienrbrt julienrbrt closed this Mar 20, 2023
@julienrbrt julienrbrt reopened this Mar 20, 2023
@github-prbot github-prbot requested a review from a team March 20, 2023 12:49
@julienrbrt julienrbrt changed the title incorrect: add changelog reminder ci: add changelog reminder Mar 20, 2023
@julienrbrt julienrbrt requested review from samricotta and tac0turtle and removed request for aaronc, alexanderbez and a team March 20, 2023 12:51

### Features

* Add rand funcs to math ([#15043](https://github.com/cosmos/cosmos-sdk/issues/15043))
Copy link
Member

Choose a reason for hiding this comment

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

this is inverting the format, if we go with this we should update the docs.

Copy link
Member Author

Choose a reason for hiding this comment

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

As this is a generated changelog, it is not supposed to be manually edited, so I think it's fine.
There are a few improvements to be made as discussed with @chatton, I've only added the git cliff to help us when tagging, to quickly verify whether the changelog is ok or not.

Copy link
Member

@tac0turtle tac0turtle Mar 20, 2023

Choose a reason for hiding this comment

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

its confusing that we have one way here and another elsewhere. Any chance we can decide on one or the other and go with it?

trying to make it consistent

Copy link
Member Author

Choose a reason for hiding this comment

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

This make sense, lmc how I can update the template!

Copy link
Member Author

Choose a reason for hiding this comment

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

Updated

@tac0turtle tac0turtle self-assigned this Mar 20, 2023
@tac0turtle
Copy link
Member

thanks

@tac0turtle tac0turtle merged commit 46169d0 into main Mar 21, 2023
@tac0turtle tac0turtle deleted the julien/changelog-reminder branch March 21, 2023 13:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants