Skip to content

Update README.md to include instructions for releasing #416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
flin-8 merged 2 commits into from
May 12, 2026
Merged

Update README.md to include instructions for releasing #416

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a2e573
Update README.md
flin-8 May 12, 2026
4ce685b
Update README.md
flin-8 May 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,13 @@ 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 in GitHub
- Since this is a GO library, it doesn't need to be pushed anywhere else to be shared

## 🤝 Contributions

Expand Down
Loading