From 569ddb28e9da115afd22b4a7531bb5b0300eb93e Mon Sep 17 00:00:00 2001 From: Tim Carr Date: Thu, 12 Jun 2025 10:45:59 +0100 Subject: [PATCH] Update Plugin Deployment Instructions --- DEPLOYMENT.md | 27 +++++++++++++++++++++------ 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/DEPLOYMENT.md b/DEPLOYMENT.md index 2578d033e..551ce4179 100644 --- a/DEPLOYMENT.md +++ b/DEPLOYMENT.md @@ -8,9 +8,13 @@ Merge the approved Pull Request(s) to the `main` branch. An *approved* Pull Request is when a PR passes all tests **and** has been approved by **one or more** reviewers. +## Create a Branch + +In your Git client / command line, create a new branch called `release-x.x.x`, where `x.x.x` is the version number. + ## Generate Localization File and Action/Filter Documentation -On your local machine, switch to the `main` branch. +On your local machine, switch to the new release branch. Run the `.scripts/build.sh` script, which will: @@ -38,7 +42,7 @@ Provide meaningful, verbose updates to the Changelog, in the following format: Generic changelog items such as `Fix: Various bugfixes` or `Several edge-case bug fixes` should be avoided. They don't tell users (or us, as developers) what took place in this version. -Each line in the changelog should start with `Added` or `Fix`. +Each line in the changelog should start with `Added`, `Fix` or `Updated`. ## Commit Changes @@ -49,9 +53,22 @@ Commit the updated files, which should comprise of: - `wp-convertkit.php` - `ACTIONS-FILTERS.md` -## Create a New Release +## Submit Release + +Once your test(s) are written and successfully run locally, submit your branch via a new [Pull Request](https://github.com/ConvertKit/convertkit-wordpress/compare). + +It's best to create a Pull Request in draft mode, as this will trigger all tests to run as a GitHub Action, allowing you to +double check all tests pass. + +If the PR tests fail, you can make code changes as necessary, pushing to the same branch. This will trigger the tests to run again. -[Create a New Release](https://github.com/ConvertKit/convertkit-wordpress/releases/new), completing the following: +If the PR tests pass, you can publish the PR, assigning some reviewers. + +## Publish Release + +Once the release branch is approved, merge it in to the `main` branch. + +Then navigate to [Create a New Release](https://github.com/ConvertKit/convertkit-wordpress/releases/new), completing the following: - Choose a tag: Click this button and enter the new version number (e.g. `1.9.6`) - Release title: The version number (e.g. `1.9.6`) @@ -59,8 +76,6 @@ Commit the updated files, which should comprise of: ![New Release Screen](/.github/docs/new-release.png?raw=true) -## Publish the Release - When you're happy with the above, click `Publish Release`. This will then trigger the [deploy.yml](.github/workflows/deploy.yml) workflow, which will upload this new version to the wordpress.org