Skip to content

Commit

Permalink
Add release checklist to readme (#356)
Browse files Browse the repository at this point in the history
Add release checklist to readme
  • Loading branch information
Anna Blendermann authored Aug 12, 2022
1 parent e978cf6 commit e85b85c
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ $ make build

**If you use RKE v0.2.x or v0.1.x, please set proper branch.**

Using the provider
Using the Provider
------------------

If you're building the provider, follow the instructions to [install it as a plugin.](https://www.terraform.io/docs/plugins/basics.html#installing-a-plugin) After placing it into your plugins directory, run `terraform init` to initialize it. Documentation about the provider specific configuration options can be found at [rke provider docs](https://registry.terraform.io/providers/rancher/rke/latest/docs).
Expand Down Expand Up @@ -123,3 +123,28 @@ Provider examples
You can view some tf file examples, [here](examples).

On Openstack you can use [terraform-openstack-rke](https://github.com/remche/terraform-openstack-rke) module.

Releasing the Provider
---------------------------

* Create a draft of the [release](https://github.com/rancher/terraform-provider-rke/releases) and select create new tag for the version you are releasing
* Create release notes by clicking `Generate release notes`
* Copy the release notes to the CHANGELOG and update to the following format

```
# <tag version> (Month Day, Year)
FEATURES:
ENHANCEMENTS:
BUG FIXES:
```

* Create a PR to update CHANGELOG
* Copy the updated notes back to the draft release (DO NOT release with just the generated notes. Those are just a template to help you)
* Make sure the branch is up-to-date with the remote, in this example, the branch is master and the release tag is v1.24.0

```
git remote add upstream-release git@github.com:rancher/terraform-provider-rke.git
git checkout upstream-release/master
git push upstream-release v1.24.0
```
* Create an [EIO issue](https://github.com/rancherlabs/eio) for Hashicorp to publish the release

0 comments on commit e85b85c

Please sign in to comment.