amazon-cloudwatch-agent icon indicating copy to clipboard operation
amazon-cloudwatch-agent copied to clipboard

Generate Github Release Note and separate versions from RELEASE_NOTES

Open khanhntd opened this issue 3 years ago • 2 comments

Description of the issue

The release process involves generate RELEASE_NOTEs manually by using git log --pretty=oneline and group all the merged PRs in one Enhancements and bug fixes. However, that would be hard to read and keep track of old versions features, bug fixes, enhancement and inconsistency with the RELEASE GITHUB NOTE. Therefore, by using github-changelog-generator to separate the merged PRs into these categories: new features, bug fixes, enhancement,.. based on labels and using github action actions/create-release@v1 to create a Github RELEASE_NOTE, we can address the aforementioned problems and reduce the steps to release new versions.

Following best practices with Release Note Github Template.

Description of changes

License

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Tests

Test against my fork with these two things:

  • Generate release note automatically with github-changelog-generator and attach the sample output (image 1) : docker run -it --rm -v "$(pwd)":"$(pwd)" --since-tag=v1.247351.0 --future-release v1.247352.0 --output build/changelog.md --user aws --project amazon-cloudwatch-agent -t {{GITHUB_ACCESS_TOKEN}}
  • Run the workflow that generates a release note to github

Requirements

Before commit the code, please do the following steps.

  1. Run make fmt and make fmt-sh
  2. Run make linter

Images

release_note.md

khanhntd avatar May 08 '22 00:05 khanhntd

Codecov Report

Merging #460 (38a3f9c) into master (be2a6bd) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #460   +/-   ##
=======================================
  Coverage   57.31%   57.31%           
=======================================
  Files         370      370           
  Lines       17352    17352           
=======================================
  Hits         9946     9946           
  Misses       6820     6820           
  Partials      586      586           

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update be2a6bd...38a3f9c. Read the comment docs.

codecov-commenter avatar May 08 '22 01:05 codecov-commenter

This PR was marked stale due to lack of activity.

github-actions[bot] avatar May 17 '22 00:05 github-actions[bot]