Skip to content

Commit d134cc5

Browse files
authored
Update RELEASING.md
adds context requested in #696 (review)
1 parent 69706ea commit d134cc5

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

‎RELEASING.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ The following content can be copied and pasted into a release issue or PR to hel
77
88
- [ ] Branch: Starting from `master`, create a branch named `release/X.Y.Z` for the release-related changes.
99
- [ ] Version bump: Bump the version number in `readme.txt` and `two-factor.php` if it does not already reflect the version being released. Update both the plugin "Version:" header value and the plugin `TWO_FACTOR_VERSION` constant in `two-factor.php`.
10-
- [ ] Changelog: Add/update the changelog in `CHANGELOG.md`. The changelog can be generated from a `compare` URL like [0.8.0...HEAD](https://github.com/WordPress/two-factor/compare/0.8.0...HEAD). Ensure the version number is added to the footer links at the bottom showing the compare from the prior version (e.g., https://github.com/WordPress/two-factor/compare/0.12.0...0.13.0). Trim the changelog entry in `readme.txt` to the least recent between a year about and the prior major release.
11-
- [ ] Props: update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
10+
- [ ] Changelog: Add/update the changelog in `CHANGELOG.md`. The changelog can be generated from a `compare` URL like [0.8.0...HEAD](https://github.com/WordPress/two-factor/compare/0.8.0...HEAD). Ensure the version number is added to the footer links at the bottom showing the compare from the prior version (e.g., https://github.com/WordPress/two-factor/compare/0.12.0...0.13.0). Trim the changelog entry in `readme.txt` to the least recent between a year ago and the prior major release.
11+
- [ ] Props: update `CREDITS.md` file with any new contributors, confirm maintainers are accurate. With the CHANGELOG.md updates completed in the step previous, open those PRs merged in the release, open the merge commits from them, and then assuming the Props Bot recommendations for Co-Authored By are included in the merge commits those GitHub usernames and the person making the merge commit can be added (where missing) to the CREDITS.md file.
1212
- [ ] New files: Check to be sure any new files/paths that are unnecessary in the production version are included in [.distignore](https://github.com/WordPress/two-factor/blob/master/.distignore).
1313
- [ ] 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.
1414
- [ ] Create Release PR: Push any local changes in `release/X.Y.Z` to origin, create a release PR, and request review to ensure all CI checks pass and ensure master branch changes are limited to merges only.

0 commit comments

Comments
 (0)