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

Minify impact of CHANGELOG.md enforcement #662

Closed
Emilgardis opened this issue Mar 17, 2022 · 2 comments · Fixed by #918
Closed

Minify impact of CHANGELOG.md enforcement #662

Emilgardis opened this issue Mar 17, 2022 · 2 comments · Fixed by #918
Labels
meta issues/PRs related to the maintenance of the crate.

Comments

@Emilgardis
Copy link
Member

Currently, if a PR adds a CHANGELOG.md entry and the base is updated with another entry, the PR will have a merge conflict.

We should somehow solve this, either by not requiring changelog entries (and automatically generating them when needed), or some other way.

@Emilgardis Emilgardis added the meta issues/PRs related to the maintenance of the crate. label Mar 17, 2022
@tombruijn
Copy link
Contributor

I'm a big fan of using changesets, small files in a .changeset directory that get merged into the CHANGELOG.md file before release. Because they're all different files there will be no conflicts.
The tool I linked is not required, there are other ways to automate it if necessary. It's just Markdown files, even the YAML frontmatter is not required if you don't want to automatically bump version numbers.
Here's a small example that hopefully helps visualize it for a Ruby gem release appsignal/appsignal-ruby@3538117 using our own publishing tool. Note the changeset file being removed and merged into the CHANGELOG.md file.

@Alexhuszagh
Copy link
Contributor

We could technically use git-cliff as well but I don't love this solution since it differs substantially from our changelog policies:

  1. It parses existing commits, which we don't enforce PRs to have a single commit.
  2. It's commit-based and not issue or PR-based: it seems to be able to changes without writing commits, but if so, it doesn't have any annotation whatsoever.

@bors bors bot closed this as completed in #918 Jul 10, 2022
@bors bors bot closed this as completed in c6bedf2 Jul 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta issues/PRs related to the maintenance of the crate.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants