From d0807f6f6d7b48da6e838d226af6c4578a9b7284 Mon Sep 17 00:00:00 2001 From: Sam Warters <281786+samwar@users.noreply.github.com> Date: Tue, 9 May 2023 10:18:12 -0500 Subject: [PATCH] Update README.md Updated the readme with release instructions. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index faf41e7..797bdb3 100644 --- a/README.md +++ b/README.md @@ -200,3 +200,17 @@ value to skip tests that build a new image. See the `tests` and `it` directories for further details on the unit and integration tests, respectively. + +Releasing a new version +======================= + +When you're ready to release a new version. Just tag the current master. +``` +git tag +``` +Be sure to create the tag following the existing conventions. After the tag has +been created, go ahead and push it up. +``` +git push origin +``` +A github action will kick off and generate a release based on the new tag.