diff --git a/.github/workflows/add_tag.yml b/.github/workflows/add_tag.yml deleted file mode 100644 index 2abd91f..0000000 --- a/.github/workflows/add_tag.yml +++ /dev/null @@ -1,50 +0,0 @@ -name: Add Version Tag - -permissions: - id-token: write - contents: write - -on: - push: - branches: - - main - -jobs: - release_commit_check: - runs-on: ubuntu-latest - outputs: - release_commit_check: ${{ steps.check_version_bump.outputs.release_commit_check }} - new_version: ${{ steps.check_version_bump.outputs.new_version }} - steps: - - name: Checkout Repository - uses: actions/checkout@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Check For Version Bump - id: check_version_bump - run: | - MESSAGE="${{ github.event.head_commit.message }}" - BUMP_REGEX="^chore\([0-9]\.[0-9]\.[0-9]\): update pyproject version.*" - BUMP_MATCH=$(echo ${MESSAGE} | egrep "${BUMP_REGEX}") || true # Prevent error code on no match - if [ -n "${BUMP_MATCH}" ] - then - NEW_VERSION=$(echo $BUMP_MATCH | sed -E "s/chore\(|\): update pyproject version.*//g") - echo "release_commit_check=true" >> $GITHUB_OUTPUT - echo "new_version=${NEW_VERSION}" >> $GITHUB_OUTPUT - fi - - add_version: - runs-on: ubuntu-latest - needs: release_commit_check - if: ${{ needs.release_commit_check.outputs.release_commit_check == 'true' }} - steps: - - name: Checkout Repository - uses: actions/checkout@v4 - with: - token: ${{ secrets.GITHUB_TOKEN }} - - name: Add Version Tag - uses: rickstaa/action-create-tag@v1 - with: - tag: ${{ needs.release_commit_check.outputs.new_version }} - commit_sha: ${{ github.sha }} - github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 15f51c6..e2fedec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -48,12 +48,17 @@ See [Semantic Versioning](https://semver.org/) for help selecting the next versi - The trigger version bump action will open a new PR with a title similar to "chore(#.#.#): update pyproject version" - Perform a squash merge on this PR to commit the version bump to main -## Confirm the Release was Created -- Navigate to [Add Version Tag Action](https://github.com/seqwell/longplexpy/actions/workflows/tag_and_release.yml). -- You should see a workflow run with a title similar to the PR title, "chore(#.#.#): update pyproject version" -- Select the action and confirm all four jobs completed successfully. -- If the jobs completed successfully, a new tag matching the "#.#.#" pattern should have been added to main. -You can check the [tags page](https://github.com/seqwell/longplexpy/tags) +## Create the Release +- In your local repository, checkout main, pull the latest changes, add and push the release tag. + ```console + git checkout main + git pull + git tag -a "#.#.#" -m "Release #.#.#" + git push --tags + ``` +- If completed successfully, a new tag matching the "#.#.#" pattern should have been added to main. +You can check the [tags page](https://github.com/seqwell/longplexpy/tags). +This will trigger the [Create Release Action](https://github.com/seqwell/longplexpy/actions/workflows/create_release.yml). - If the jobs completed successfully, there should also be a new release on the [releases page](https://github.com/seqwell/longplexpy/releases).