From e85b85c4d86239433d8f5cb868d2ea4a19c51e38 Mon Sep 17 00:00:00 2001 From: Anna Blendermann Date: Fri, 12 Aug 2022 16:56:27 -0400 Subject: [PATCH] Add release checklist to readme (#356) Add release checklist to readme --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f3dfaec9..2219539e 100644 --- a/README.md +++ b/README.md @@ -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). @@ -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 + +``` +# (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 \ No newline at end of file