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

Release: 2.1.0 #1297

Merged
merged 6 commits into from
Feb 10, 2025
Merged

Release: 2.1.0 #1297

merged 6 commits into from
Feb 10, 2025

Conversation

github-actions[bot]
Copy link

@github-actions github-actions bot commented Feb 7, 2025

  • Branch: Starting from develop, create a release branch named release/2.1.0 for your changes.
  • Version bump: Bump the version number in distributor.php, package-lock.json, package.json, readme.txt and tests/php/bootstrap.php if it does not already reflect the version being released. In distributor.php update both the plugin "Version:" property and the plugin DT_VERSION constant.
  • Changelog: Add/update the changelog in CHANGELOG.md.
  • Props: Update CREDITS.md file with any new contributors, confirm maintainers are accurate.
  • Readme updates: Make any other readme changes as necessary. README.md is geared toward GitHub and readme.txt contains WordPress.org-specific content. The two are slightly different.
  • New files: Ensure any new files, especially in the vendor folder, are correctly included in webpack.config.release.js.
  • Since tag updates: ensure @since tags indicate the new version, replacing x.x.x, n.e.x.t and other placeholders.
  • Merge: Make a non-fast-forward merge from your release branch to develop (or merge the Pull Request), then do the same for develop into trunk (git checkout develop && git pull origin develop && git checkout trunk && git pull origin trunk && git merge --no-ff develop). trunk contains the stable development version.
  • Push: Push your trunk branch to GitHub (e.g. git push origin trunk).
  • Compare trunk to develop to ensure no additional changes were missed.
  • Build: Wait for the Build Stable Release Action to finish running.
  • Review: Do a review of the commit to the stable branch to ensure the contents of the diffs are as expected.
  • Test: Check out the stable branch and test it locally to ensure everything works as expected. It is recommended that you rename the existing distributor directory and check out stable fresh because switching branches does not delete files. This can be done with git clone --single-branch --branch stable [email protected]:10up/distributor.git
  • Either perform a regression testing utilizing the available Critical Flows and Test Cases or if end-to-end tests cover a significant portion of those Critical Flows then run e2e tests. Only proceed if everything tests successfully.
  • Release: Create a new release, naming the tag and the release with the new version number, and targeting the stable branch. Paste the changelog from CHANGELOG.md into the body of the release and include a link to the closed issues on the milestone. The release should now appear under releases.
  • Check release: Wait for the Publish Release Action to complete, and then check the latest release to ensure that the ZIP has been attached as an asset. Download the ZIP and inspect the contents to be sure they match the contents of the stable branch.
  • Close milestone: Edit the milestone with release date (in the Due date (optional) field) and link to GitHub release (in the Description field), then close the milestone.
  • Punt incomplete items: If any open issues or PRs which were milestoned for 2.1.0 do not make it into the release, update their milestone to 2.2.0, or Future Release.

@dkotter dkotter requested a review from jeffpaul February 7, 2025 15:31
@dkotter dkotter self-assigned this Feb 7, 2025
@dkotter dkotter added this to the 2.1.0 milestone Feb 7, 2025
@dkotter dkotter marked this pull request as ready for review February 7, 2025 15:32
@dkotter dkotter requested a review from a team as a code owner February 7, 2025 15:32
@dkotter dkotter removed the request for review from a team February 7, 2025 15:32
@@ -1178,7 +1178,7 @@ function update_content_image_urls( int $post_id, array $images ) {
/**
* Filter whether image URLS should be updated in the content.
*
* @since x.x.x
* @since 2.1.0
Copy link
Member

Choose a reason for hiding this comment

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

nice catch, may be worth adding to the release steps as well?

Copy link
Collaborator

@dkotter dkotter Feb 7, 2025

Choose a reason for hiding this comment

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

It is already there: Since tag updates: ensure @ since tags indicate the new version, replacing x.x.x, n.e.x.t and other placeholders

Though I don't think we have this same step across our other plugins so would be nice to add that in, as we often don't update those until I see them later

Copy link
Member

@jeffpaul jeffpaul left a comment

Choose a reason for hiding this comment

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

Looks good, thanks for handling the release!

@dkotter dkotter merged commit 127b11c into develop Feb 10, 2025
17 of 18 checks passed
@dkotter dkotter deleted the release/2.1.0 branch February 10, 2025 15:19
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