Skip to content

Commit

Permalink
Document the release process some more (#413)
Browse files Browse the repository at this point in the history
  • Loading branch information
srtfisher authored Dec 31, 2024
1 parent cd9e83e commit 077faf1
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 8 deletions.
31 changes: 24 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit 077faf1

Please sign in to comment.