From c1e0773a094bac6df5fb1b5a717aeb7ab9002ebc Mon Sep 17 00:00:00 2001
From: Jonathan Ballet <jon@multani.info>
Date: Fri, 9 Sep 2022 09:55:06 +0200
Subject: [PATCH] Describe the release process (#9)

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index cc77ab7..02e17f8 100644
--- a/README.md
+++ b/README.md
@@ -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"
 }
 ```
 
@@ -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