From 4e33a659be3f36250a96b3b81b22f971d9a21761 Mon Sep 17 00:00:00 2001 From: ryanbooth Date: Fri, 20 May 2022 11:38:16 -0500 Subject: [PATCH] update CONTRIBUTING.md with build instructions --- CONTRIBUTING.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e0da105..7ecf247 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,4 +39,17 @@ Black is used to format code pre-commit ``` black aos/ black tests/ -``` \ No newline at end of file +``` + +## Building Releases +This function is currently handled by the project admin team. GitHub +releases is currently used for release management. Git tags are used to +manage release version numbers. +### steps +1. `git tag v0.x.y-beta` +2. `git push --tags` +3. From Github validate the new tag is present with the correct commit. +4. From Github create a new release based on the new tag. +5. Github actions will then pick up the new release and trigger a release +build and publish to pypi using the tagged version number +