From b291782635bbb605fcd784778fa7bb8b16b02488 Mon Sep 17 00:00:00 2001 From: Bjarte Mehus Sunde Date: Fri, 18 Oct 2024 17:10:18 +0900 Subject: [PATCH] fix: release workflow (#31) This PR updates our Semantic Release workflow to align with best practices and official documentation. Key changes include: 1. Simplified the workflow to use the official Python Semantic Release GitHub Action. 2. Adjusted permissions to ensure proper access for creating releases and tags. 3. Updated pyproject.toml to prevent double publishing to PyPI. These changes aim to: - Streamline our release process - Improve reliability and consistency of our versioning --- .github/workflows/release.yml | 48 ++++++++--------------------------- pyproject.toml | 2 +- 2 files changed, 11 insertions(+), 39 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b895907..f2de67e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,27 +1,18 @@ -name: Create New Release +name: Semantic Release on: + push: + branches: + - main workflow_dispatch: - inputs: - dry-run: - description: | - Perform a dry run release (check for testing, uncheck for real release) - - Checked (true): Simulates the release process without making changes - - Unchecked (false): Creates an actual release with version bump - Note: Ensure all desired changes are merged to main before releasing - required: true - default: true - type: boolean jobs: release: - name: Create Release runs-on: ubuntu-latest + concurrency: release permissions: + id-token: write contents: write - issues: write - pull-requests: write - actions: write steps: - name: Checkout code @@ -29,27 +20,8 @@ jobs: with: fetch-depth: 0 - - name: Set up Python - uses: actions/setup-python@v4 + - name: Python Semantic Release + id: release + uses: python-semantic-release/python-semantic-release@v9.12.0 with: - python-version: '3.12' - - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install python-semantic-release - - - name: Configure Git - run: | - git config user.name "github-actions[bot]" - git config user.email "github-actions[bot]@users.noreply.github.com" - - - name: Run semantic-release - env: - GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} - run: | - if [ "${{ github.event.inputs.dry-run }}" = "true" ]; then - semantic-release publish --dry-run --verbose - else - semantic-release publish --verbose - fi + github_token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 98d4951..8a95a41 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -22,4 +22,4 @@ upload_to_pypi = false build_command = "pip install build && python -m build" [tool.semantic_release.git] -tag_format = "v{version}" +tag_format = "v{version}" \ No newline at end of file