Skip to content

Commit a7256d0

Browse files
authored
Add release process (#292)
1 parent 0e4c814 commit a7256d0

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

release-process.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Release Process
2+
3+
This document outlines the steps involved in the release process for the NGINX Plus Go Client project.
4+
5+
## Versioning
6+
7+
The project follows [Semantic Versioning](https://semver.org/) for versioning.
8+
9+
## Release Planning and Development
10+
11+
The features that will go into the next release are reflected in the
12+
corresponding [milestone](https://github.com/nginxinc/nginx-plus-go-client/milestones). Refer to
13+
the [Issue Lifecycle](/ISSUE_LIFECYCLE.md) document for information on issue creation and assignment to releases.
14+
15+
## Releasing a New Version
16+
17+
1. Create an issue to define and track release-related activities. Choose a title that follows the
18+
format `Release X.Y.Z`.
19+
2. Stop merging any new work into the main branch.
20+
3. Check the release draft under the [GitHub releases](https://github.com/nginxinc/nginx-plus-go-client/releases) page
21+
to ensure that everything is in order.
22+
4. Create and push the release tag in the format `vX.Y.Z`:
23+
24+
```bash
25+
git tag -a vX.Y.Z -m "Release vX.Y.Z"
26+
git push origin vX.Y.Z
27+
```
28+
29+
As a result, the CI/CD pipeline will publish the release and announce it in the community Slack.

0 commit comments

Comments
 (0)