From d47c9c379f0ecec295897d99564f24af6cceba39 Mon Sep 17 00:00:00 2001 From: mart-r Date: Thu, 26 Jun 2025 13:25:23 +0100 Subject: [PATCH 1/3] Update release barnch name in description of wokrflow --- .github/workflows/medcat-v2_release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/medcat-v2_release.yml b/.github/workflows/medcat-v2_release.yml index f3f26cf61..b50c1286d 100644 --- a/.github/workflows/medcat-v2_release.yml +++ b/.github/workflows/medcat-v2_release.yml @@ -31,7 +31,7 @@ jobs: # NOTE: branch name is in line with version tag, except for the patch version BRANCH_NAME="${VERSION_TAG%.*}" # This removes the patch version (everything after the second dot) - # Check out the corresponding release branch (e.g., medcat-v0.1) + # Check out the corresponding release branch (e.g., medcat/v0.1) git checkout $BRANCH_NAME # Ensure the branch is up-to-date with the remote From 672143b8880383e900306fbd033920630f50e2ae Mon Sep 17 00:00:00 2001 From: mart-r Date: Thu, 26 Jun 2025 13:27:35 +0100 Subject: [PATCH 2/3] Update release README with correct branch name --- medcat-v2/.release/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/medcat-v2/.release/README.md b/medcat-v2/.release/README.md index 363fa794b..20eb1faa2 100644 --- a/medcat-v2/.release/README.md +++ b/medcat-v2/.release/README.md @@ -4,7 +4,7 @@ The scripts within here are designed to help preparing for and dealing with rele The main idea is to use the `prepare_release.sh` script from within the root of the project and it will delegate either to `prepare_minor_release.sh` or `prepare_patch_release.sh` as necessary. The workflow within the scripts is as follows: -- Create or check out release branch (`release/v.`) +- Create or check out release branch (`medcat/v.`) - Update version in `pyproject.toml` - Create a tag based on the version - Push both the branch as well as the tag to `origin` From 659633f541d331b2a8dec5c967af2e73af41e510 Mon Sep 17 00:00:00 2001 From: mart-r Date: Thu, 26 Jun 2025 13:28:38 +0100 Subject: [PATCH 3/3] Add comment about tag foramt to release README --- medcat-v2/.release/README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/medcat-v2/.release/README.md b/medcat-v2/.release/README.md index 20eb1faa2..4dc1702d6 100644 --- a/medcat-v2/.release/README.md +++ b/medcat-v2/.release/README.md @@ -7,6 +7,7 @@ The workflow within the scripts is as follows: - Create or check out release branch (`medcat/v.`) - Update version in `pyproject.toml` - Create a tag based on the version + - This will be in the format `medcat/v..` - Push both the branch as well as the tag to `origin` The general usage for a minor release based on the `main` branch from within the **root of the project** is simply: