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

[WIP] Prepare 3.6.2 #2324

Merged
merged 13 commits into from
Aug 26, 2021
Merged

[WIP] Prepare 3.6.2 #2324

merged 13 commits into from
Aug 26, 2021

Conversation

felipeelia
Copy link
Member

@felipeelia felipeelia commented Aug 23, 2021

  • 1. If the new version requires a reindex, add its number to the $reindex_versions array in the ElasticPress\Upgrades::check_reindex_needed() method. If it is the case, remember to add that information to the Changelog listings in readme.txt and CHANGELOG.md.
  • 2. Branch: Starting from develop, cut a release branch named release/X.Y.Z for your changes.
  • 3. Version bump: Bump the version number in elasticpress.php, package.json, readme.txt, and any other relevant files if it does not already reflect the version being released. In elasticpress.php update both the plugin "Version:" property and the plugin EP_VERSION constant.
  • 4. Changelog: Add/update the changelog in CHANGELOG.md and readme.txt, ensuring to link the [X.Y.Z] release reference in the footer of CHANGELOG.md (e.g., X.Y.Z-1...X.Y.Z).
  • 5. Props: Update CREDITS.md file with any new contributors, confirm maintainers are accurate.
  • 6. 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.
  • 7. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in .gitattributes.
  • 8. Merge: Merge the release branch/PR into develop, then make a non-fast-forward merge from develop into master (git checkout master && git merge --no-ff develop). master contains the stable development version.
  • 9. Test: While still on the master branch, test for functionality locally.
  • 10. Push: Push your master branch to GitHub (e.g. git push origin master).
  • 11. Release: Create a new release, naming the tag and the release with the new version number, and targeting the master branch. Paste the release changelog from CHANGELOG.md into the body of the release and include a link to the closed issues on the milestone.
  • 12. SVN: Wait for the GitHub Action to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
  • 13. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/elasticpress/. This may take a few minutes.
  • 14. 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.
  • 15. Punt incomplete items: If any open issues or PRs which were milestoned for X.Y.Z do not make it into the release, update their milestone to X.Y.Z+1, X.Y+1.0, X+1.0.0 or Future Release.

@felipeelia felipeelia self-assigned this Aug 23, 2021
@felipeelia felipeelia added this to the 3.6.2 milestone Aug 23, 2021
@jeffpaul
Copy link
Member

FYI I did a compare and found a couple items missing from CHANGELOG.md, those have now been added. I'll mirror those into the readme.txt changelog and check the CREDITS.md file next.

@jeffpaul
Copy link
Member

@felipeelia I've handled steps 4 and 5, back to you to continue onward 🚀

@felipeelia felipeelia merged commit 2aa5bfd into develop Aug 26, 2021
@felipeelia felipeelia deleted the release/3.6.2 branch August 26, 2021 17:08
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