Skip to content

Commit

Permalink
Workflow for new release: Improved instructions
Browse files Browse the repository at this point in the history
Signed-off-by: Gunnar Andersson <[email protected]>
  • Loading branch information
gunnar-mb committed Jan 14, 2025
1 parent b4848e7 commit 4ffc611
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions .github/workflows/create-new-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,17 @@
# Preconditions:
# 1) The tag that is determined from the commit message must not already exist
# 2) The workflow does not work if pushing an existing tag.
# 3) The precondition ensures this workflow is NOT run if no RELEASE-TAG field.
# 3) The precondition ensures this workflow is NOT run if a RELEASE-TAG is
# not found in the commit message.
#
# Action steps:
# 1) Commit and add the RELEASE-TAG in message
# 2) Tag locally with the tag
# DO NOT PUSH THE TAG
# 1) Set package version number in setup.py and add RELEASE-TAG: line to the commit message
# 2) Tag locally with the tag name
# DO NOT PUSH THE TAG! *
# 3) Push commit (possibly via a pull request)
# 4) When pushed or merge to master, the release process will create the remote tag and the release
# 4) When pushed or merged to master, the release process will create the remote tag and the release
# (Note: Since we use and expect fast-forward merges, "merging" here means fast forwarding
# and therefore the local tag should be on the same commit as the one created remotely.)

name: Create release tag and publish JSON Schema

Expand Down

0 comments on commit 4ffc611

Please sign in to comment.