Merge pull request #2 from cloudquery/chore/add_release_docs

chore(docs): Add release guide
Swetrix · Feb 17, 2023 · 2dcdbe6 · 2dcdbe6
2 parents 80f5219 + f577f4b
commit 2dcdbe6
Showing 1 changed file with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -4,9 +4,9 @@ A Swetrix source plugin for CloudQuery that loads data from Swetrix to any datab
 
 ## Links
 
- - [CloudQuery Quickstart Guide](https://www.cloudquery.io/docs/quickstart)
- - [Configuration](docs/configuration.md)
- - [Supported Tables](docs/tables/README.md)
+- [CloudQuery Quickstart Guide](https://www.cloudquery.io/docs/quickstart)
+- [Configuration](docs/configuration.md)
+- [Supported Tables](docs/tables/README.md)
 
 ## Authentication
 
@@ -30,4 +30,12 @@ make lint
 
 ```bash
 make gen-docs
-```
+```
+
+### Release a new version
+
+1. Run `git tag v1.0.0` to create a new tag for the release (replace `v1.0.0` with the new version number)
+2. Run `git push origin v1.0.0` to push the tag to GitHub  
+
+Once the tag is pushed, a new GitHub Actions workflow will be triggered to build the release binaries and create the new release on GitHub.
+To customize the release notes, see the Go releaser [changelog configuration docs](https://goreleaser.com/customization/changelog/#changelog).