Skip to content

Conversation

@codingLogan
Copy link
Collaborator

@codingLogan codingLogan commented May 2, 2025

Our workflow currently requires manual changes...

  • Determine what version to bump to
  • Add the new version notes to CHANGELOG.md
  • Add the new version to package.json
  • Merge conflicts require manual change and re-approval because of the version number differences

New workflow proposal

  • Add conventional commits as a standard, to help generate package releases and versions automatically
  • On merge, let semantic-release determine the new version
  • On merge, let semantic-release update and tag the package
  • On merge, let semantic-release update GitHub/npm with release notes
  • Major change - CHANGELOG is no longer update in our codebase (as recommended by semantic-release). GitHub release notes now contain this information.
  • Major change - package.json version is no longer updated in our codebase (as recommended by semantic-release). Before publishing to npm, the version is updated compared to the latest git tags.

Reasons

  • 👎🏻 We trip over each other's PRs often, and have to seek out re-approvals for PRs that have been tested, but the docs or the version need updating
  • 🤖 Automation saves time - As long as we apply the conventional commits correctly
  • 😄 Fun - it makes working with the repo more friendly

References

@codingLogan codingLogan force-pushed the lr/workflow-update branch 7 times, most recently from 1113211 to ce10eaf Compare May 9, 2025 22:01
@codingLogan codingLogan changed the title DRAFT DO NOT MERGE - Workflow experiments GitHub Actions - Automate npm package updates and release notes May 9, 2025
@codingLogan codingLogan force-pushed the lr/workflow-update branch from 99d05cb to ce10eaf Compare May 12, 2025 17:38
@codingLogan codingLogan force-pushed the lr/workflow-update branch from 85b9ca9 to bd99992 Compare May 13, 2025 17:44
@codingLogan codingLogan added the enhancement New feature or request label May 13, 2025
Copy link
Collaborator

@ash-wright123 ash-wright123 left a comment

Choose a reason for hiding this comment

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

LGTM

@codingLogan codingLogan merged commit 132ac89 into master May 13, 2025
3 checks passed
@github-actions
Copy link

🎉 This PR is included in version 0.16.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@codingLogan codingLogan deleted the lr/workflow-update branch November 12, 2025 15:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants