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

add changelog builder for release publishing #1377

Merged
merged 1 commit into from
Jul 12, 2024

Conversation

alaviss
Copy link
Contributor

@alaviss alaviss commented Jul 10, 2024

Summary

Add changelog builder to the publishing workflow. This allows us to
provide richer release information to users.

Details

The changelog builder will tally all PRs merged between the previous tag
and the latest tag, then generate a categorized changelog for them. The
configuration for the builder can be found at .github/changelog.json
.

In addition to this, /generate-changelog PR command has been added,
which allows maintainers to generate a changelog based on the new
configuration within a given PR.

Usage:

/generate-changelog [from=<tag>] [to=<tag>] [no_prerelease=<true|false>]

Where:

  • from : Specify the previous tag. If not provided, will be the first
    tag older than to .
  • to : Specify the latest tag. If not provided, will be the latest
    tag in this repository.
  • no_prerelease : Only applies when from is not provided. If set
    to true , from is selected such that the older tag is /not/ a
    pre-release. Defaults to false .

@alaviss
Copy link
Contributor Author

alaviss commented Jul 10, 2024

Sample changelog attached below for 0.1.0-dev.21277...0.1.0-dev.21375

Note that PR references are rendered differently in a release, where they are only displayed as short refs (eg. #<number>) instead of full PR name.


What's Changed

🚀 Features

Compiler

Standard Library

🐛 Fixes

Compiler

Standard Library

Tooling

🔧 Refactorings

Compiler

Standard Library

💬 Other

Full Changelog: 0.1.0-dev.21277...0.1.0-dev.21375

@alaviss alaviss marked this pull request as ready for review July 11, 2024 01:44
@alaviss alaviss requested a review from a team as a code owner July 11, 2024 01:44
@alaviss alaviss added enhancement New feature or request ci Continuous Integration labels Jul 11, 2024
Copy link
Collaborator

@saem saem left a comment

Choose a reason for hiding this comment

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

Change itself looks good, for the PR body the summary and details bodies can probably be switched.

@alaviss
Copy link
Contributor Author

alaviss commented Jul 11, 2024

Does this look better?

@alaviss
Copy link
Contributor Author

alaviss commented Jul 12, 2024

/merge

Let's just go for it

Copy link

Merge requested by: @alaviss

Contents after the first section break of the PR description has been removed and preserved below:


Notes for Reviewers

  • This is a part of the upcoming release pipeline.
  • This PR will be un-drafted after the test run in my repository completes. Confirmed functional.

@chore-runner chore-runner bot added this pull request to the merge queue Jul 12, 2024
Merged via the queue into nim-works:devel with commit 1a6e125 Jul 12, 2024
31 checks passed
@alaviss alaviss deleted the push-lqswvnxuyprt branch July 12, 2024 03:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci Continuous Integration enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants