Skip to content

Commit

Permalink
CONTRIBUTING.md: Add release guide (hashicorp#1168)
Browse files Browse the repository at this point in the history
* CONTRIBUTING.md: Add release guide

* Apply suggestions from code review

Co-authored-by: Daniel Banck <dbanck@users.noreply.github.com>

* CONTRIBUTING.md: reflect prepare workflow

---------

Co-authored-by: Daniel Banck <dbanck@users.noreply.github.com>
  • Loading branch information
radeksimko and dbanck authored Feb 8, 2023
1 parent aa03d7d commit e8ed548
Showing 1 changed file with 37 additions and 0 deletions.
37 changes: 37 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,3 +196,40 @@ promptly to pull requests, particularly if they do not relate to an existing
GitHub issue where the maintainer team has already participated. We _are_
grateful for all contributions however, and will give feedback on pull requests
as soon as we're able to.

## Releasing

Releases are made on a reasonably regular basis by the maintainers (HashiCorp staff), using our internal tooling. The following notes are only relevant to maintainers.

Release process:

1. Update [`version/VERSION`](https://github.com/hashicorp/terraform-ls/blob/main/version/VERSION) to remove `-dev` suffix and set it to the intended version to be released
1. Wait for [`build` workflow](https://github.com/hashicorp/terraform-ls/actions/workflows/build.yml) and dependent `prepare` workflow to finish
1. Ensure you have the appropriate GitHub PAT set in `BOB_GITHUB_TOKEN` variable
1. Set `SHA` to the corresponding (long) last commit SHA (after updating `VERSION` file) & `VERSION` to the same version
1. Use `bob` to promote artifacts to **staging**
```
bob trigger-promotion \
--product-name=terraform-ls \
--environment=terraform-ls-oss \
--org=hashicorp \
--repo=terraform-ls \
--slack-channel=C02AGQXCAF5 \
--product-version="$VERSION" \
--sha="$SHA" \
--branch=main \
staging
```
1. Use `bob` to promote artifacts to **production**
```
bob trigger-promotion \
--product-name=terraform-ls \
--environment=terraform-ls-oss \
--org=hashicorp \
--repo=terraform-ls \
--slack-channel=C02AGQXCAF5 \
--product-version="$VERSION" \
--sha="$SHA" \
--branch=main \
production
```

0 comments on commit e8ed548

Please sign in to comment.