Skip to content

Conversation

@BrianHenryIE
Copy link
Contributor

@BrianHenryIE BrianHenryIE commented Apr 24, 2025

Proposed changes

To avoid failures where the version in main is not updated and the release version then does not match, enforce a rule that the CHANGELOG.md must contain an updated version before merging to main. If the version in CHANGELOG.md on main is already higher than the previous release, the Action will pass.

Type of Change

Production

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Dependency update
  • Refactoring / housekeeping (changes to files not directly related to functionality)

Development

  • Tests
  • Dependency update
  • Environment update / refactoring
  • Documentation Update

Video

Example workflow failure due to version mismatch:

Screenshot 2025-04-24 at 11 12 43 AM

Example of this check running:

Screenshot 2025-04-24 at 11 13 02 AM

Example where no CHANGELOG.md exists on main

Screenshot 2025-04-24 at 11 14 14 AM

Checklist

  • I have read the CONTRIBUTING doc
  • I have viewed my change in a web-browser
  • Linting and tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)

Further comments

  • This should probably only run on changes to PHP and JS files
  • Uses samcarswell/semver-compare-action under the hood
  • We might need to change names/titles/error messages to be perfectly clear on failure

Copilot AI review requested due to automatic review settings April 24, 2025 18:22
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR introduces a new GitHub Actions workflow to enforce that the CHANGELOG.md file is updated with a new version before merging to main, preventing version mismatches on release.

  • Established a version bump check using a third-party action.
  • Configured the workflow to run on pull requests targeting the main branch.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 24, 2025

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.

2 participants