Skip to content

Commit

Permalink
add release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobbednarz committed Jul 20, 2022
1 parent 735e199 commit 5cb5a34
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/release-process.md
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.

0 comments on commit 5cb5a34

Please sign in to comment.