Skip to content

Small release documention fixes #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 26, 2025
Merged

Small release documention fixes #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d47c9c3
Update release barnch name in description of wokrflow
mart-r Jun 26, 2025
672143b
Update release README with correct branch name
mart-r Jun 26, 2025
659633f
Add comment about tag foramt to release README
mart-r Jun 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/medcat-v2_release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion medcat-v2/.release/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@ 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<major>.<minor>`)
- Create or check out release branch (`medcat/v<major>.<minor>`)
- Update version in `pyproject.toml`
- Create a tag based on the version
- This will be in the format `medcat/v<major>.<minor>.<patch>`
- 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:
Expand Down