From 077faf1fe4a783a0a7a97ac398d4750f2a51002e Mon Sep 17 00:00:00 2001 From: Sean Fisher Date: Tue, 31 Dec 2024 10:34:22 -0500 Subject: [PATCH] Document the release process some more (#413) --- README.md | 31 ++++++++++++++++++++++++------- composer.json | 3 ++- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index b41dacbe..c9199f88 100644 --- a/README.md +++ b/README.md @@ -137,15 +137,32 @@ npx wp-scripts packages-update --dist-tag=wp-6.7` ## Releasing the Plugin -The plugin uses a [built release workflow](./.github/workflows/built-release.yml) -to compile and tag releases. Whenever a new version is detected in the root -`composer.json` file or in the plugin's headers, the workflow will automatically -build the plugin and tag it with a new version. The built tag will contain all -the required front-end assets the plugin may require. This works well for -publishing to WordPress.org or for submodule-ing. +The plugin uses +[action-release](https://github.com/alleyinteractive/action-release) via a +[built release workflow](./.github/workflows/built-release.yml) to compile and +tag releases. Whenever a new version is detected in the root plugin's headers in +the `plugin.php` file or in the `composer.json` file, the workflow will +automatically build the plugin and tag it with a new version. The built tag will +contain all the required front-end assets the plugin may require. This works +well for publishing to WordPress.org or for submodule-ing. When you are ready to release a new version of the plugin, you can run -`npm run release` to start the process of setting up a new release. +`npm run release`/`composer release` to start the process of setting up a new +release. If you want to do this manually you can follow these steps: + +1. Change the `Version` in the `plugin.php` file to a new higher-level version. + + ```diff + - * Version: 0.0.0 + + * Version: 0.0.1 + ``` + + **✨ `npm run release` will do this for you automatically.** + +2. Commit your changes and push to the repository. +3. Check the actions tab in the repository to see the progress of the release. + The action will automatically create a new tag and release for the plugin. + You are done! ## Changelog diff --git a/composer.json b/composer.json index c4c739e0..df823125 100644 --- a/composer.json +++ b/composer.json @@ -49,8 +49,9 @@ "scripts": { "phpcbf": "phpcbf .", "phpcs": "phpcs .", - "phpunit": "phpunit", "phpstan": "phpstan --memory-limit=512M", + "phpunit": "phpunit", + "release": "npx @alleyinteractive/create-release@latest", "test": [ "@phpcs", "@phpstan",