-
Notifications
You must be signed in to change notification settings - Fork 623
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1001 from jacobbednarz/release-docs
Release docs
- Loading branch information
Showing
2 changed files
with
38 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
```release-note:note | ||
docs: add release notes | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
## Release Process | ||
|
||
We aim to release on a fortnightly cadence, alternating weeks with the [terraform-provider-cloudflare](https://github.com/cloudflare/terraform-provider-cloudflare). | ||
|
||
This is to accommodate downstream tools and allow cahnges from this library to | ||
be used in the other systems without a month long delay. | ||
|
||
If a hotfix is needed, the same process outlined below is used however only the | ||
semantic versioning patch version is bumped. | ||
|
||
- Ensure CI is passing for [`master` branch](https://github.com/cloudflare/cloudflare-go/actions?query=branch%3Amaster). | ||
- Remove "(Unreleased)" portion from the header for the version you are intending | ||
to release (here, 2.27.0). Create a new H2 above for the next unreleased | ||
version (here 2.28.0). Example diff: | ||
|
||
```diff | ||
+ ## 2.28.0 (Unreleased) | ||
|
||
+ ## 2.27.0 | ||
- ## 2.27.0 (Unreleased) | ||
|
||
NOTES: | ||
|
||
* dependency: Update foo to v0.0.2 ([#1184](https://github.com/cloudflare/cloudflare-go/issues/123)) | ||
``` | ||
|
||
Bumping the minor version is usually fine here unless you are intending on | ||
releasing a major version bump. | ||
|
||
- Create a new GitHub release with the release title exactly matching the tag | ||
(e.g. `v2.27.0`) and copy the entries from the CHANGELOG to the release notes. | ||
- A GitHub Action will now build the binaries, documentation and create the release. | ||
- Once this is completed, close off the milestone for the current release and | ||
open the next that matches the CHANGELOG additions from earlier. Example: close | ||
v2.27.0 but open a v2.28.0. |