Skip to content

Commit e0df2d2

Browse files
authored
Small release documention fixes (#12)
* Update release barnch name in description of wokrflow * Update release README with correct branch name * Add comment about tag foramt to release README
1 parent ac4d8c2 commit e0df2d2

File tree

2 files changed

+3
-2
lines changed

2 files changed

+3
-2
lines changed

.github/workflows/medcat-v2_release.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ jobs:
3131
# NOTE: branch name is in line with version tag, except for the patch version
3232
BRANCH_NAME="${VERSION_TAG%.*}" # This removes the patch version (everything after the second dot)
3333
34-
# Check out the corresponding release branch (e.g., medcat-v0.1)
34+
# Check out the corresponding release branch (e.g., medcat/v0.1)
3535
git checkout $BRANCH_NAME
3636
3737
# Ensure the branch is up-to-date with the remote

medcat-v2/.release/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,10 @@ The scripts within here are designed to help preparing for and dealing with rele
44

55
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.
66
The workflow within the scripts is as follows:
7-
- Create or check out release branch (`release/v<major>.<minor>`)
7+
- Create or check out release branch (`medcat/v<major>.<minor>`)
88
- Update version in `pyproject.toml`
99
- Create a tag based on the version
10+
- This will be in the format `medcat/v<major>.<minor>.<patch>`
1011
- Push both the branch as well as the tag to `origin`
1112

1213
The general usage for a minor release based on the `main` branch from within the **root of the project** is simply:

0 commit comments

Comments
 (0)