Merge pull request #74 from Charliekenney23/add-release-doc

Add release workflow documentation
linode · Jul 27, 2021 · e7c903e · e7c903e
2 parents 497b91a + ea14fc0
commit e7c903e
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -34,6 +34,12 @@ Tips for a faster merge:
  * make sure your commits are atomic, [addressing one change per commit](https://chris.beams.io/posts/git-commit/). 
  * add tests!
 
+## Cutting Releases
+
+ Everytime a commit is merged into master, a new patch release is [automatically drafted](https://github.com/linode/linode-blockstorage-csi-driver/actions/workflows/release-drafter.yml) with a changelog. You can modify (tag name, changelog, title, etc.) and publish the release via the [releases page](https://github.com/linode/linode-blockstorage-csi-driver/releases).
+
+ When a release is published, the [release workflow](https://github.com/linode/linode-blockstorage-csi-driver/actions/workflows/docker-hub.yml) builds and pushes the docker image to Dockerhub.
+
 ## Code of Conduct
 
 This project follows the [Linode Community Code of Conduct](https://www.linode.com/community/questions/conduct).