Skip to content

Commit e9de238

Browse files
author
Jeremy Udit
committed
1 parent b89835b commit e9de238

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

RELEASE.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
## Release Flow
2+
3+
Since the migration to the [Terraform registry](https://registry.terraform.io/), this repository's maintainers now have
4+
the ability to self-publish Terraform GitHub provider releases. This process leverages Github Actions
5+
and [`goreleaser`](https://github.com/goreleaser/goreleaser) to build, sign, and upload provider binaries to a Github release.
6+
7+
The release flow is as follows:
8+
1. Create a CHANGELOG entry for the release using the following format:
9+
```markdown
10+
## x.y.z (release date)
11+
12+
## ENHANCEMENTS:
13+
...
14+
15+
## BUG FIXES:
16+
...
17+
```
18+
1. Tag the commit that adds the CHANGELOG entry with the release version and push:
19+
```shell
20+
$ git tag x.y.z
21+
$ git push origin x.y.z
22+
```
23+
1. Github Actions will trigger the release workflow which can be
24+
[viewed here](https://github.com/integrations/terraform-provider-github/actions?query=workflow%3Arelease).
25+
After the workflow executes successfully, the Github release created in the prior step will
26+
have the relevant assets available for consumption.
27+
1. The new release will show up in https://registry.terraform.io/providers/integrations/github/latest for consumption
28+
by terraform `0.13.X` users.
29+
1. For terraform `0.12.X` users, the new release is available for consumption once it is present in
30+
https://releases.hashicorp.com/terraform-provider-github/.

0 commit comments

Comments
 (0)