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

feat: configure automated changelog generation #237

Merged
merged 1 commit into from
Dec 27, 2024

Conversation

huynguyen-hl
Copy link
Contributor

Description

This PR introduces the Create Changelog and Release workflows.

When a commit is pushed to a release/* branch (e.g., release/1.0.0, release/1.0.1, etc.), the create-changelog.yml workflow is triggered to generate or update the CHANGELOG.md file and create a corresponding PR.

The create-changelog.yml workflow utilizes the googleapis/release-please-action@v4 library to identify the changes made between the previous version and the current version, then generates or updates the CHANGELOG.md file accordingly.

Once the changelog PR is merged into the release branch, the release preparation is considered complete. At this point, the release branch can be merged into the main branch. This action triggers the release.yml workflow, which generates a new tag and creates a corresponding GitHub release. With these steps, the release process is finalized.

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

https://github.com/gs-gs/fa-ag-trace/issues/848

Mobile & Desktop Screenshots/Recordings

  • The workflow is triggered after a commit is merged into the release/* branch:
image
  • A PR is created by the create-changelog.yml workflow:
image
  • Files changed:
image

After the release is merged into the main branch:

image

A tag is automatically created by the release.yml workflow, and its value corresponds to the version defined in the version.json file:

image

A GitHub release is automatically created once the tag is successfully generated. The release notes for this step are automatically generated by the create-changelog.yml workflow

image

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help

Added to documentation?

  • 📜 README.md
  • 📕 storybook
  • 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

[optional] What gif best describes this PR or how it makes you feel?

Copy link

Coverage report

Caution

Coverage does not meet threshold
Statements coverage not met for global: expected <=25 not covered statements, but got 0

St.
Category Percentage Covered / Total
🟢 Statements 100% 0/0
🟢 Branches 100% 0/0
🟢 Functions 100% 0/0
🟢 Lines 100% 0/0

Test suite run success

0 tests passing in 0 suite.

Report generated by 🧪jest coverage report action from 31c45e3

@huynguyen-hl huynguyen-hl merged commit 7ac71d5 into next Dec 27, 2024
3 checks passed
@huynguyen-hl huynguyen-hl deleted the feat/automated-changelog-generation branch December 27, 2024 10:35
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.

3 participants