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 generation for submodules #15452

Closed
wants to merge 9 commits into from
Closed

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Mar 18, 2023

Description

Closes: #15415

Inspired from the cliff.toml config from IBC over and tweaked it for our usage.
Currently, it will only generate changelog for everything except the SDK changelog, which needs more context and will keep being handwritten.

Other modules in the repo like math, core, hubl, rosetta, etc.. will get their changelog auto-generated when tagging.
To generate a changelog before tagging, run make changelog module=path/to/submodule tag=vx.y.z.


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
Copy link
Member Author

I have played with it and I have found a few issues:

  • Doing it automatically, even when having some rules to skip some commits and include path, still adds fall positives. (e.g. when we update the dependencies with pseudo versions, it will add a changelog for that, while we do not want that).
  • We use far too much the prefix chore while it isn't really chore as per the definition of conventional commits, which leads to having the commit wrongly placed. (Not per se an issue from the tool, but ours)

Example good changelog: math
Example bad changelog: core

@julienrbrt julienrbrt closed this Mar 20, 2023
@julienrbrt julienrbrt deleted the julien/changelog branch March 20, 2023 09:11
@julienrbrt julienrbrt restored the julien/changelog branch March 20, 2023 09:30
@julienrbrt julienrbrt reopened this Mar 20, 2023
@julienrbrt julienrbrt closed this Mar 20, 2023
@julienrbrt julienrbrt mentioned this pull request Mar 20, 2023
19 tasks
@julienrbrt julienrbrt deleted the julien/changelog branch March 20, 2023 10:32
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.

Generate changelogs
1 participant