Manual Release #11
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Manual Release | |
on: | |
workflow_dispatch: | |
inputs: | |
release_type: | |
description: 'Type of release (major, minor, patch, or specific)' | |
required: true | |
type: choice | |
options: | |
- major | |
- minor | |
- patch | |
- specific | |
specific_version: | |
description: 'Specify version if release type is "specific" (e.g., 1.0.0)' | |
required: false | |
jobs: | |
release: | |
runs-on: ubuntu-latest | |
outputs: | |
new_release_version: ${{ steps.get_new_version.outputs.new_release_version }} | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # Essential for getting full history to capture all PRs | |
- name: Get latest release version and calculate new version | |
id: get_new_version | |
run: | | |
latest_tag=$(git describe --tags --abbrev=0 2>/dev/null || echo "v0.0.0") | |
echo "Latest tag: $latest_tag" | |
current_version=${latest_tag#v} | |
IFS='.' read -r -a version_parts <<< "$current_version" | |
major=${version_parts[0]} | |
minor=${version_parts[1]} | |
patch=${version_parts[2]} | |
new_version="" | |
release_type="${{ github.event.inputs.release_type }}" | |
if [ "$release_type" == "specific" ]; then | |
if [ -z "${{ github.event.inputs.specific_version }}" ]; then | |
echo "Error: specific_version is required when release_type is specific." | |
exit 1 | |
fi | |
new_version="${{ github.event.inputs.specific_version }}" | |
elif [ "$release_type" == "major" ]; then | |
new_version="$((major + 1)).0.0" | |
elif [ "$release_type" == "minor" ]; then | |
new_version="${major}.$((minor + 1)).0" | |
elif [ "$release_type" == "patch" ]; then | |
new_version="${major}.${minor}.$((patch + 1))" | |
else | |
echo "Error: Invalid release_type provided." | |
exit 1 | |
fi | |
echo "New calculated version: v$new_version" | |
echo "new_release_version=v$new_version" >> "$GITHUB_OUTPUT" | |
# For the changelog builder, ensure we pass '' if no previous tag, to get all history | |
echo "latest_existing_tag=$latest_tag" >> "$GITHUB_OUTPUT" | |
- name: Create Git Tag | |
id: create_git_tag | |
run: | | |
git config user.name "GitHub Actions" | |
git config user.email "[email protected]" | |
git tag ${{ steps.get_new_version.outputs.new_release_version }} | |
git push origin ${{ steps.get_new_version.outputs.new_release_version }} | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
- name: Generate Changelog | |
id: generate_changelog | |
uses: mikepenz/release-changelog-builder-action@v5 | |
with: | |
# If 'latest_existing_tag' is 'v0.0.0', fromTag becomes '', | |
# instructing the action to build the changelog from the very first commit. | |
# Otherwise, it builds from the last official release tag. | |
fromTag: ${{ steps.get_new_version.outputs.latest_existing_tag == 'v0.0.0' && '' || steps.get_new_version.outputs.latest_existing_tag }} | |
toTag: ${{ steps.get_new_version.outputs.new_release_version }} | |
configurationJson: | | |
{ | |
"template": "# Changes\n\n{{CHANGELOG}}", | |
"exclude_labels": ["skip-changelog", "duplicate", "wip"], | |
"commit_mode": false # Explicitly set to false to ONLY capture PRs. This is the default, | |
# but being explicit ensures clarity. | |
# Do NOT set to true or "HYBRID" if you only want PRs. | |
} | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
- name: Create GitHub Release | |
id: create_release | |
uses: actions/create-release@v1 | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
with: | |
tag_name: ${{ steps.get_new_version.outputs.new_release_version }} | |
release_name: Release ${{ steps.get_new_version.outputs.new_release_version }} | |
body: ${{ steps.generate_changelog.outputs.changelog }} | |
draft: false | |
prerelease: false | |
cleanup_on_failure: | |
runs-on: ubuntu-latest | |
needs: release | |
if: ${{ always() && (needs.release.result == 'failure' || needs.release.result == 'cancelled') }} | |
steps: | |
- name: Checkout code (for tag deletion) | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Delete Git Tag on Failure | |
run: | | |
TAG_TO_DELETE="${{ needs.release.outputs.new_release_version }}" | |
if [ -n "$TAG_TO_DELETE" ]; then | |
echo "Deleting tag: $TAG_TO_DELETE due to workflow failure/cancellation." | |
git config user.name "GitHub Actions" | |
git config user.email "[email protected]" | |
git push origin --delete "$TAG_TO_DELETE" || true | |
else | |
echo "No tag to delete or new_release_version not set from previous job." | |
fi | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} |