Skip to content

Commit

Permalink
Describe the release process (#9)
Browse files Browse the repository at this point in the history
  • Loading branch information
multani committed Sep 9, 2022
1 parent ee72df6 commit c1e0773
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Then, enable it with:
```hcl
plugin "camunda-saas" {
enabled = true
version = "v1.1.0"
source = "github.com/camunda-cloud/tflint-ruleset-camunda-saas"
}
```

Expand All @@ -24,6 +26,32 @@ Open the [documentation](./docs/README.md) to get the list of rules.

## Development

### Making a release

1. Create a new Git tag, using the `vX.Y.Z` format:

```
git tag --annotate --sign --message "Release vX.Y.Z" vX.Y.Z
```

1. Push the new tag to GitHub:

```
git push origin vX.Y.Z
```

1. GitHub Actions should take care of creating the artifacts and creating the GitHub Releases.
1. Update the TFLint configuration file to use the new version:

```hcl
plugin "camunda-saas" {
enabled = true
version = "vX.Y.Z"
source = "github.com/camunda-cloud/tflint-ruleset-camunda-saas"
}
```



### Building the plugin

Expand Down

0 comments on commit c1e0773

Please sign in to comment.