Skip to content

Commit 5ef69ba

Browse files
committed
Merge branch 'primary' into fix-missing-build-files-update-version
2 parents 5e50c50 + 63e0899 commit 5ef69ba

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,21 @@ The `release` branch matches the latest stable release deployed to [wp.org](wp.o
1717

1818
## Release Process
1919

20-
1. Merge your feature branch into `primary` with a PR. This PR should include any necessary updates to the changelog in readme.txt and README.md.
21-
2. After merging the release PR to the `release` branch, a draft Release will be automatically created by the [`build-tag-release`](https://github.com/pantheon-systems/pantheon-content-publisher-wordpress/.github/workflows/build-tag-release.yml) workflow. This draft release will be automatically pre-filled with release notes.
22-
3. Confirm that the necessary assets are present in the newly created tag, and test on a WP install if desired.
23-
4. Review the release notes, making any necessary changes, and publish the release.
24-
5. Wait for the [_Release pantheon-advanced-page-cache plugin to wp.org_ action](https://github.com/pantheon-systems/pantheon-content-publisher-wordpress/.github/workflows/wordpress-plugin-deploy.yml) to finish deploying to the WordPress.org plugin repository. If all goes well, users with SVN commit access for that plugin will receive an email with a diff of the changes.
25-
6. Check WordPress.org: Ensure that the changes are live on the plugin repository. This may take a few minutes.
26-
7. Following the release, prepare the next dev version with the following steps:
20+
1. Merge feature branches into `primary` with a PR. This PR should include any necessary updates to the changelog in readme.txt and README.md. Features should be _squash merged_.
21+
1. From `primary`, checkout a new branch `release_X.Y.Z`.
22+
1. Make a release commit:
23+
* In `README.md`, `readme.txt`, `package.json, package-lock.json`, and `pantheon-content-publisher.php`, remove the -dev from the version number. For the README files. the version number must be updated both at the top of the document as well as the changelog.
24+
* Add the date to the ** X.Y.X ** heading in the changelogs in README.md, readme.txt, and any other appropriate location.
25+
* Commit these changes with the message "Release X.Y.Z"
26+
1. Push the release branch up.
27+
1. Open a pull request to merge `release_X.Y.Z` into release. Your PR should consist of all commits to main since the last release, and one commit to update the version number. The PR name should also be Release X.Y.Z.
28+
1. After all tests pass and you have received approvals from CODEOWNERs, merge the PR into `release`. A merge commit is needed in this case. **Never** squash to release.
29+
1. After merging to the `release` branch, a draft Release will be automatically created by the [`build-tag-release`](https://github.com/pantheon-systems/pantheon-content-publisher-wordpress/.github/workflows/build-tag-release.yml) workflow. This draft release will be automatically pre-filled with release notes.
30+
1. Confirm that the necessary assets are present in the newly created tag, and test on a WP install if desired.
31+
1. Review the release notes, making any necessary changes, and publish the release.
32+
1. Wait for the [_Release pantheon-content-publisher plugin to wp.org_ action](https://github.com/pantheon-systems/pantheon-content-publisher-wordpress/.github/workflows/wordpress-plugin-deploy.yml) to finish deploying to the WordPress.org plugin repository. If all goes well, users with SVN commit access for that plugin will receive an email with a diff of the changes.
33+
1. Check WordPress.org: Ensure that the changes are live on the plugin repository. This may take a few minutes.
34+
1. Following the release, prepare the next dev version with the following steps:
2735
* `git checkout release`
2836
* `git pull origin release`
2937
* `git checkout primary`
@@ -33,3 +41,4 @@ The `release` branch matches the latest stable release deployed to [wp.org](wp.o
3341
* `git add -A .`
3442
* `git commit -m "Prepare X.Y.X-dev"`
3543
* `git push origin primary`
44+
1. Publish a public release note on [Pantheon's Documentation](https://github.com/pantheon-systems/documentation/) with the changelog and any notes.

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,11 @@
5151

5252
## Quick start
5353

54-
This is a WordPress plugin. It can be installed via the usual WordPress Dashboard workflow.
54+
The Pantheon Content Publisher plugin can be installed like any other WordPress Plugin, from your WordPress Dashboard, go to Plugins -> Add Plugin and search for: Pantheon Content Publisher, click the Install Now button and then click Activate.
55+
56+
After the plugin is active, set up your connection to Pantheon Content Publisher and Google Drive via the settings page in the WordPress admin dashboard.
57+
58+
Alternately you can download and install the plugin manually:
5559

5660
- [Download the latest release.](https://github.com/pantheon-systems/pantheon-content-publisher-wordpress/releases/)
5761

0 commit comments

Comments
 (0)