Skip to content

Conversation

@bobbrodie
Copy link
Contributor

Overview

I was thinking about how we could do releases with fewer clicks and still automating the release notes, so I've built a manual workflow.

Here's how it works:

  1. Go to Actions
  2. Select Release from the left-hand panel
  3. On the right, click the Run workflow button
  4. Choose a Version bump type (_patch_, _minor_, or _major_), which will be used in npm version
  5. Enter a release overview, which is used in the release notes above "What's new" (Readme.com shows the first line in the changelog list view, so it's good to have something other than "What's new" show)
Screenshot 2025-07-16 at 8 00 48 PM

When you run the workflow, it will:

  1. Check out the project
  2. Set up Node.js
  3. Install the dependencies
  4. Set the git username and email
  5. Run npm version to bump the package.json and package-lock.json, but we use --no-git-tag-version because it prefixes with a v and we don't want that for this project
  6. Uses jq to get the version without v
  7. Add package.json and package-lock.json
  8. Commit
  9. Tag
  10. Push to the branch that the workflow was run against
  11. Push the tag
  12. Get a list of PRs
  13. Use the GitHub API (with the gh command) to get a list of PR titles so we don't need all the "by @dependabot" text
  14. Create the GitHub release
  15. Push the release notes to the Readme.com changelog

Here's an example from my repo:

Screenshot 2025-07-16 at 8 00 09 PM

@bobbrodie bobbrodie self-assigned this Jul 17, 2025
@bobbrodie bobbrodie merged commit a661b91 into 7.0.x Jul 17, 2025
6 checks passed
@bobbrodie bobbrodie added this to the v7.0.3 milestone Jul 17, 2025
@bobbrodie bobbrodie moved this to Done in SDKs & Plugins Jul 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

3 participants