From 7e10040bbd7f51efa9359924f247c57aa502e89c Mon Sep 17 00:00:00 2001 From: erinhmclark Date: Fri, 7 Mar 2025 18:04:51 +0000 Subject: [PATCH] Update the release description to tag on release --- docs/source/development/release.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/source/development/release.md b/docs/source/development/release.md index 0d9407c..a2ed4c6 100644 --- a/docs/source/development/release.md +++ b/docs/source/development/release.md @@ -2,8 +2,9 @@ ```{note} This is a work in progress. ``` +### Update the project version -1. Update the version number in the project file: [pyproject.toml](../../pyproject.toml) following SemVer: +Update the version number in the project file: [pyproject.toml](../../pyproject.toml) following SemVer: ```toml [project] name = "auto-archiver" @@ -11,17 +12,15 @@ version = "0.1.1" ``` Then commit and push the changes. -2. Next add a new git tag with the version number: -```shell -git tag -a v0.1.1 -git push origin v0.1.1 -``` - * The package version is automatically updated in PyPi using the workflow [python-publish.yml](../../.github/workflows/python-publish.yml) * A Docker image is automatically pushed with the git tag to dockerhub using the workflow [docker-publish.yml](../../.github/workflows/docker-publish.yml) +### Create the release on Git -3. Go to GitHub releases > new release > and select the tag you just created. +The release needs a git tag which should match the project version number, prefixed with a 'v'. For example, if the project version is `0.1.1`, the git tag should be `v0.1.1`. +This can be done the usual way, or created within the Github UI when you create the release. + +Go to GitHub releases > new release > create the release with the new tag and the release notes. manual release to docker hub