Conversation
Update release directions based on lessons from Release 1.3.0 Signed-off-by: Ipstenu (Mika Epstein) <Ipstenu@users.noreply.github.com>
… streamline package registration Signed-off-by: Mika <ipstenu@halfelf.org> Signed-off-by: Mika Ipstenu Epstein <ipstenu@halfelf.org>
…r display for plugins. Introduced methods to register hooks for plugin update errors and display relevant messages in the admin interface. Signed-off-by: Mika Ipstenu Epstein <ipstenu@halfelf.org>
Signed-off-by: Mika Epstein <ipstenu@halfelf.org> Signed-off-by: Mika Ipstenu Epstein <ipstenu@halfelf.org>
cdils
left a comment
There was a problem hiding this comment.
A couple of minor suggestions on RELEASE.MD.
Are the other files in this PR intended?
| 3. Repeat steps 2-6 for the next RC (e.g., `1.2.0-rc2`) | ||
|
|
||
| ### If the RC is validated and ready for production: | ||
| Proceed to the **Production Release** workflow below to merge `development` → `main` for the final release. |
There was a problem hiding this comment.
Shouldn't this be merge release/X.Y.Z → main ?
There was a problem hiding this comment.
Or even just full stop here:
Proceed to the Production Release workflow below.
Yes. It won’t pass checks otherwise. The gitignore is because I used vim, and git kept trying to add swp files. |
|
|
||
| ### Release Candidate (RC) | ||
| A release candidate is a pre-release version intended for testing and validation before the final production release. Multiple RCs may be created and tested before the final release. | ||
| - **Version format:** `MAJOR.MINOR.PATCH-rcN` (e.g., `1.2.0-rc1`, `1.2.0-rc2`) |
There was a problem hiding this comment.
I believe the usual manner is to use capital RC.
|
|
||
| ### Release Candidate (RC) | ||
| A release candidate is a pre-release version intended for testing and validation before the final production release. Multiple RCs may be created and tested before the final release. | ||
| - **Version format:** `MAJOR.MINOR.PATCH-rcN` (e.g., `1.2.0-rc1`, `1.2.0-rc2`) |
There was a problem hiding this comment.
| - **Version format:** `MAJOR.MINOR.PATCH-rcN` (e.g., `1.2.0-rc1`, `1.2.0-rc2`) | |
| - **Version format:** `MAJOR.MINOR.PATCH-RC#` (e.g., `1.2.0-RC1`, `1.2.0-RC2`) |
There was a problem hiding this comment.
I used # here instead of N as I thought it would be more readable.
| 2. Complete the following fields: | ||
|
|
||
| - **Use workflow from:** Select **Branch: release/X.Y.Z** | ||
| - **New version being released:** Enter the RC version using the format `X.Y.Z-rcN` (e.g., `1.2.0-rc1`, `1.2.0-rc2`) |
There was a problem hiding this comment.
| - **New version being released:** Enter the RC version using the format `X.Y.Z-rcN` (e.g., `1.2.0-rc1`, `1.2.0-rc2`) | |
| - **New version being released:** Enter the RC version using the format `X.Y.Z-RC#` (e.g., `1.2.0-RC1`, `1.2.0-RC2`) |
| 2. Click the **Draft a new release** button. | ||
|
|
||
| 3. In the **Select tag** field: | ||
| - Select the tag that matches the version you just bumped to (e.g., `1.2.0-rc1`). |
There was a problem hiding this comment.
| - Select the tag that matches the version you just bumped to (e.g., `1.2.0-rc1`). | |
| - Select the tag that matches the version you just bumped to (e.g., `1.2.0-RC1`). |
| - Create a new tag if it does not appear in the dropdown. | ||
| - **Target branch:** Select `development` | ||
|
|
||
| 4. In the **Release title** field, enter a title for the release (e.g., `1.2.0-rc1`). |
There was a problem hiding this comment.
| 4. In the **Release title** field, enter a title for the release (e.g., `1.2.0-rc1`). | |
| 4. In the **Release title** field, enter a title for the release (e.g., `1.2.0-RC1`). |
| ### If additional testing iterations are needed: | ||
| 1. Continue making fixes on the `release/X.Y.Z` branch | ||
| 2. Merge fixes back to `development` | ||
| 3. Repeat steps 2-6 for the next RC (e.g., `1.2.0-rc2`) |
There was a problem hiding this comment.
| 3. Repeat steps 2-6 for the next RC (e.g., `1.2.0-rc2`) | |
| 3. Repeat steps 2-6 for the next RC (e.g., `1.2.0-RC2`) |
| 1. Log in to Fastly and go to the Fair.pm page: https://manage.fastly.com/configure/services/0EAkUOqF5q35zrk6oobCP4 | ||
| 2. From the Purge menu option, select **Purge URL** | ||
| 3. Leave subdomain blank and put in the path `/wp-json/git-updater/v1/update-api/` | ||
| 4. When prompted, purse another URL |
There was a problem hiding this comment.
| 4. When prompted, purse another URL | |
| 4. When prompted, purge another URL |
| 4. In a new browser tab, go to the repository’s **Actions** tab and confirm all workflows have completed. | ||
| ## 9. Verify the release: | ||
| - Visit the [Releases page](https://github.com/fairpm/fair-plugin/releases) to confirm latest release. | ||
| - Go to `https://api.fair.pm/git-updater/v1/update-api/?slug=fair-plugin` and check |
There was a problem hiding this comment.
| - Go to `https://api.fair.pm/git-updater/v1/update-api/?slug=fair-plugin` and check | |
| - Go to `https://api.fair.pm/git-updater/v1/update-api/?slug=fair-plugin` and check | |
| - For development releases, go to `https://api.fair.pm/git-updater/v1/update-api/?slug=fair-plugin&channel=development` and check | |
Update release directions based on lessons from Release 1.3.0