Skip to content

Add 'Build Release' workflow to simplify release steps #59799

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

Draft
wants to merge 3 commits into
base: trunk
Choose a base branch
from

Conversation

jorgeatorres
Copy link
Member

@jorgeatorres jorgeatorres commented Jul 19, 2025

Submission Review Guidelines:

Changes proposed in this Pull Request:

This PR introduces workflow Release: Build Release which simplifies the process of building a new release by combining various steps into just one workflow (such as bumping versions, generating changelog, ZIP and GH release).

Screenshot 2025-07-21 at 18 28 29

The only input required by this workflow is the version you intend to release (and the date) and it'll perform all the required steps.

Important

Because the final ZIP includes all relevant changes, modifications made to the PRs generated by this workflow (such as the one bumping versions or updating the changelog) are not reflected in the final ZIP. As such, for cases where certain adjustments need to be made manually, this workflow doesn't offer any flexibility and the release steps need to be performed individually instead.

Closes #57936.

How to test the changes in this Pull Request:

Using the WooCommerce Testing Instructions Guide, include your detailed testing instructions:

  1. Fork this repository, including trunk and at least the release/10.0 branch.
  2. On your machine, make any changes in the release/10.0 branch and generate a changelog file. Push the changes.
  3. Go to Actions > Release: Build release and run the workflow with version 10.0.4 and any date of your choosing as release date.
  4. Wait until the process completes and go to Code > Releases and confirm that there's a draft release for 10.0.4 with a ZIP attached.
  5. Download the ZIP and confirm that the version in the woocommerce.php header is indeed 10.0.4 and that the changelog in readme.txt includes the changelog entry you created in step 2.
  6. Go to Pull requests in your fork, and confirm that there are PRs open for:
    • Bumping the version number in release/10.0 to 10.0.4.
    • Updating the changelog in branch release/10.0.
  7. Go to Actions > Release > Build release and attempt to run it using versions such as 10.0.0-rc.3, 10.0.4 (which already exists) or 10.1.0 and confirm that the workflow fails as expected.

Testing that has already taken place:

Changelog entry

  • Automatically create a changelog entry from the details below.
  • This Pull Request does not require a changelog entry. (Comment required below)
Changelog Entry Details

Significance

  • Patch
  • Minor
  • Major

Type

  • Fix - Fixes an existing bug
  • Add - Adds functionality
  • Update - Update existing functionality
  • Dev - Development related task
  • Tweak - A minor adjustment to the codebase
  • Performance - Address performance issues
  • Enhancement - Improvement to existing functionality

Message

Changelog Entry Comment

Comment

@github-actions github-actions bot added the focus: monorepo infrastructure Issues and PRs related to monorepo tooling. label Jul 19, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
focus: monorepo infrastructure Issues and PRs related to monorepo tooling.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Changelog and version bump should happen as part of release workflow
1 participant