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

[Feature] Automate changelog generation for non-alpha/beta releases #37

Merged
merged 17 commits into from
Nov 28, 2023

Conversation

narin
Copy link
Contributor

@narin narin commented Nov 27, 2023

Ticket #7053

Description of Change

  • Adds changelog generation to publish workflow using github-changelog-generator
  • Changelogs will be generated using the titles of PRs merged since the last tag. Note: when we eventually move our issues to a separate ZenHug instance, we'll be able to generate changelogs based on closed issues instead.
  • Generates changelog for the specified package being published
  • Filters out alpha and beta tags
  • Adds setup-ruby step, Gemfile, and Gemfile.lock for caching
  • Update PR template for clearer PR naming suitable for changelogs

Testing Packages

components-v0.2.2-alpha.0...21

Screenshots/Video

image

Testing

  • Tested on GHA

PR Checklist

Code reviewer validation:

  • General
    • PR is linked to ticket(s)
    • Acceptance criteria:
      • All satisfied or
      • Documented reason for not being performed or
      • Split to separate ticket and ticket is linked by relevant AC(s)
    • Above PR sections adequately filled out
    • If any breaking changes, in accordance with the pre-1.0.0 versioning guidelines: a CU ticket has been created for the VA Mobile App detailing necessary adjustments with the package version that will be published by this ticket
  • Code
    • Tests are included if appropriate (or split to separate ticket)
    • New functions have proper TSDoc annotations

Publish

If changes warrant a new version per the versioning guidelines and the PR is approved and ready to merge:

@narin narin marked this pull request as ready for review November 28, 2023 01:29
@narin narin requested a review from a team as a code owner November 28, 2023 01:29
@narin narin merged commit 684d5e5 into main Nov 28, 2023
5 checks passed
@narin narin deleted the feature/7053-narin-automate-changelog branch November 28, 2023 03:58
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