You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-16Lines changed: 14 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,38 +26,36 @@ The `develop` branch is the development branch which means it contains the next
26
26
27
27
## Release instructions
28
28
29
-
Open a [new blank issue](https://github.com/scoredetect/timestamps/issues/new) with `[Release] 1.12.1`, then copy and paste the following items, replacing version numbers and links to the milestone.
29
+
Open a [new blank issue](https://github.com/scoredetect/timestamps/issues/new) with `[Release] 1.13.0`, then copy and paste the following items, replacing version numbers and links to the milestone.
30
30
31
-
-[ ]1. Branch: Starting from `develop`, cut a release branch named `release/1.12.1` for your changes.
31
+
-[ ]1. Branch: Starting from `develop`, cut a release branch named `release/1.13.0` for your changes.
32
32
-[ ]2. Version bump: Bump the version number in `timestamps.php`, `package.json`, `package-lock.json`, `readme.txt`, and any other relevant files if it does not already reflect the version being released. In `timestamps.php` update both the plugin "Version:" property and the plugin `SDCOM_TIMESTAMPS_VERSION` constant.
33
-
-[ ]3. Changelog: Add/update the changelog in `CHANGELOG.md`, ensuring to link the [1.12.1] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/scoredetect/timestamps/compare/1.12.1-1...1.12.1).
33
+
-[ ]3. Changelog: Add/update the changelog in `CHANGELOG.md`, ensuring to link the [1.13.0] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/scoredetect/timestamps/compare/1.13.0-1...1.13.0).
34
34
-[ ]4. Props: Update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
35
35
-[ ]5. 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.
36
36
-[ ]6. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.distignore`.
37
-
-[ ]7. POT file: Run `wp i18n make-pot . lang/timestamps.pot` and commit the file. In case of errors, try to disable Xdebug.
38
-
-[ ]8. Release date: Double check the release date in the `CHANGELOG.md` file.
39
-
-[ ]9. Merge: Merge the release branch/PR into `develop`, then make a non-fast-forward merge from `develop` into `main` (`git checkout main && git merge --no-ff develop`). `main` contains the stable development version.
40
-
-[ ]10. Test: While still on the `main` branch, test for functionality locally.
41
-
-[ ]11. Push: Push your `main` branch to GitHub (e.g. `git push origin main`).
42
-
-[ ]12.[Check the _Build and Tag_ action](https://github.com/scoredetect/timestamps/actions/workflows/build-and-tag.yml): a new tag named with the version number should've been created. It should contain all the built assets.
43
-
-[ ]13. Release: Create a [new release](https://github.com/scoredetect/timestamps/releases/new):
37
+
-[ ]7. Release date: Double check the release date in the `CHANGELOG.md` file.
38
+
-[ ]8. Merge: Merge the release branch/PR into `develop`, then make a non-fast-forward merge from `develop` into `main` (`git checkout main && git merge --no-ff develop`). `main` contains the stable development version.
39
+
-[ ]9. Test: While still on the `main` branch, test for functionality locally.
40
+
-[ ]10. Push: Push your `main` branch to GitHub (e.g. `git push origin main`).
41
+
-[ ]11.[Check the _Build and Tag_ action](https://github.com/scoredetect/timestamps/actions/workflows/build-and-tag.yml): a new tag named with the version number should've been created. It should contain all the built assets.
42
+
-[ ]12. Release: Create a [new release](https://github.com/scoredetect/timestamps/releases/new):
44
43
***Tag**: The tag created in the previous step
45
-
***Release title**: `Version 1.12.1`
44
+
***Release title**: `Version 1.13.0`
46
45
***Description**: Release changelog from `CHANGELOG.md` + `See: https://github.com/scoredetect/timestamps/milestone/#?closed=1`
47
-
-[ ]14. SVN: Wait for the [GitHub Action](https://github.com/scoredetect/timestamps/actions/workflows/push-deploy.yml) 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.
48
-
-[ ]15. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/timestamps/. This may take a few minutes.
46
+
-[ ]13. SVN: Wait for the [GitHub Action](https://github.com/scoredetect/timestamps/actions/workflows/push-deploy.yml) 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.
47
+
-[ ]14. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/timestamps/. This may take a few minutes.
49
48
50
49
## Hotfix release instructions
51
50
52
51
There may be cases where we have an urgent/important fix that ideally gets into a release quickly without any other changes (e.g., a "hotfix") so as to reduce (1) the amount or testing before being confident in the release and (2) to reduce the chance of unintended side effects from the extraneous non-urgent/important changes. In cases where code has previously been merged into `develop` but that ideally is not part of a hotfix, the normal release instructions above will not suffice as they would release all code merged to `develop` alongside the intended urgent/important "hotfix" change(s). In case of needing to release a "hotfix" the following are the recommended steps to take.
53
52
54
-
1. Branch: Starting from `main`, cut a hotfix release branch named `hotfix/1.12.1` for your hotfix change(s).
53
+
1. Branch: Starting from `main`, cut a hotfix release branch named `hotfix/1.13.0` for your hotfix change(s).
55
54
1. Version bump: Bump the version number in `timestamps.php`, `package.json`, `readme.txt`, and any other relevant files if it does not already reflect the version being released. In `timestamps.php` update both the plugin "Version:" property and the plugin `SDCOM_TIMESTAMPS_VERSION` constant.
56
-
1. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt`, ensuring to link the [1.12.1] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/scoredetect/timestamps/compare/1.12.1-1...1.12.1).
55
+
1. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt`, ensuring to link the [1.13.0] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/scoredetect/timestamps/compare/1.13.0-1...1.13.0).
57
56
1. Props: Update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
58
57
1. 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.
59
58
1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.distignore`.
60
-
1. POT file: Run `wp i18n make-pot . lang/timestamps.pot` and commit the file.
61
59
1. Release date: Double check the release date in both changelog files.
62
60
1. Merge: Merge the release branch/PR into `main`. `main` contains the stable development version.
63
61
1. Test: While still on the `main` branch, test for functionality locally.
0 commit comments