From 0a2e5736974503320055b0dcbf6755c0861de8b3 Mon Sep 17 00:00:00 2001 From: Frank Lin Date: Tue, 12 May 2026 10:21:51 +1000 Subject: [PATCH 1/2] Update README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 4c377a26..6d08cf49 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,12 @@ and add a Visual Studio Code workspace setting (`.vscode/settings.json`) for the "go.testEnvFile": "${workspaceFolder}/.env" } ``` +## Release + +Once your pull request has been approved: +1. **Squash** (not merge) your PR with a [conventional commit]([url](https://www.conventionalcommits.org/en/v1.0.0/#summary)) message + - Merged PR's will still make it into the release notes, but the release notes will also be polluted with the merge commit (see [example]([url](https://github.com/OctopusDeploy/go-octopusdeploy/releases/tag/v2.107.0))) +3. Tag the commit with the next version number - the [release workflow]([url](https://github.com/OctopusDeploy/go-octopusdeploy/actions/workflows/release.yml)) then trigger to create the release ## 🤝 Contributions From 4ce685b0533a9c5511d9d53e9146766085f5ffdf Mon Sep 17 00:00:00 2001 From: Frank Lin Date: Tue, 12 May 2026 10:23:42 +1000 Subject: [PATCH 2/2] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 6d08cf49..431a4225 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,8 @@ and add a Visual Studio Code workspace setting (`.vscode/settings.json`) for the Once your pull request has been approved: 1. **Squash** (not merge) your PR with a [conventional commit]([url](https://www.conventionalcommits.org/en/v1.0.0/#summary)) message - Merged PR's will still make it into the release notes, but the release notes will also be polluted with the merge commit (see [example]([url](https://github.com/OctopusDeploy/go-octopusdeploy/releases/tag/v2.107.0))) -3. Tag the commit with the next version number - the [release workflow]([url](https://github.com/OctopusDeploy/go-octopusdeploy/actions/workflows/release.yml)) then trigger to create the release +3. Tag the commit with the next version number - the [release workflow]([url](https://github.com/OctopusDeploy/go-octopusdeploy/actions/workflows/release.yml)) then trigger to create the release in GitHub + - Since this is a GO library, it doesn't need to be pushed anywhere else to be shared ## 🤝 Contributions