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: build changelog automatically #54

Closed
wants to merge 8 commits into from
Closed

Conversation

nadiamoe
Copy link
Contributor

@nadiamoe nadiamoe commented Jan 22, 2021

This PR (attempts to) implement automated changelog generation for releases.

Goals:

  • Autogenerate changelog based on commits or, preferrably, merged PRs.
  • Use changelog as release body.
  • Generate a CHANGELOG file and put it in the archives.

Feedback

The generated changelog for the singe release can be found here

The generated full changelog can be viewed with the following command:

curl -L https://github.com/newrelic/nri-docker/releases/download/v9.9.9/nri-docker_9.9.9-1_amd64.deb | tar -xz --to-stdout data.tar.gz | tar -xz --to-stdout ./usr/share/doc/nri-docker/CHANGELOG.md

Or in this gist: https://gist.github.com/roobre/ae85275179856928c4807e5033865eaa

Appending release notes can be done by opening a "meta-issue", which is a bit cumbersome but still doable. The action has support for noticing features, bugfixes, and breaking changes depending on issue labels. The full capabilities of the generator can be seen here

@nadiamoe nadiamoe changed the title ci: build changelog automatically wip: ci: build changelog automatically Jan 22, 2021
@nadiamoe nadiamoe force-pushed the santalla/auto-changelog branch 2 times, most recently from e5456ec to 4b3539d Compare January 22, 2021 10:24
@nadiamoe nadiamoe force-pushed the santalla/auto-changelog branch from 7cee723 to 22d1f97 Compare January 22, 2021 13:26
@nadiamoe nadiamoe force-pushed the santalla/auto-changelog branch from 96f29a5 to 84069c5 Compare January 22, 2021 14:43
@nadiamoe nadiamoe changed the title wip: ci: build changelog automatically ci: build changelog automatically Jan 25, 2021
Comment on lines 102 to 105
issues: true
issuesWoLabels: true
pullRequests: true
prWoLabels: true
Copy link
Contributor Author

Choose a reason for hiding this comment

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

These four shouldn't need to be specified. A bug has been reported upstream: janheinrichmerker/action-github-changelog-generator#23

@nadiamoe nadiamoe self-assigned this Jan 26, 2021
uses: heinrichreimer/github-changelog-generator-action@v2.2
with:
token: ${{ secrets.GITHUB_TOKEN }}
issues: true
Copy link
Contributor

Choose a reason for hiding this comment

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

i would not add issues. We will end up populating the changelog with things that are not related to code changes like this one

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 can try to add issues but only those with labels (bug, enhancement, etc.) and see how it comes.

@gsanchezgavier
Copy link
Contributor

Excellent tool , this will automate the changelog and give it richer info. I just have a concern about the issues that are added in the changelog.

@arvdias
Copy link

arvdias commented Jan 27, 2021

Looks good. Is the PRs section always named "Merged pull requests" ? Ideally we would have sections named "Added", "Changed" and "Fixed" but i guess we can't control this very well. I think I had tried this tool before and didn't see how we could do that, although I didn't spend much time with it.

@nadiamoe
Copy link
Contributor Author

Due to the increased complexity and upstream bugs we're dropping this from the epic for now. Closing.

@nadiamoe nadiamoe closed this Jan 27, 2021
@paologallinaharbur paologallinaharbur deleted the santalla/auto-changelog branch February 14, 2024 13:32
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.

None yet

3 participants