Improve release action (#68)

Author: kasium

.github/workflows/release.yml

@@ -2,14 +2,71 @@ name: Release
 
 permissions:
   contents: write
+  pull-requests: write
 
 on:
-  push:
-    tags:
-      - v*
+  workflow_dispatch:
+    inputs:
+      version:
+        description: Release version (e.g., 1.2.3)
+        required: true
+        type: string
+  pull_request:
+    types: [closed]
+    branches:
+      - main
 
 jobs:
-  release:
+  create-release-pr:
+    if: github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      - name: Setup python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: .python-version
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version-file: pyproject.toml
+      - name: Install dependencies
+        run: uv sync --all-groups --all-extras
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+      - name: Create release branch
+        run: |
+          git checkout -b release/${{ inputs.version }}
+      - name: Build Changelog
+        run: uv run towncrier build --yes --version ${{ inputs.version }}
+      - name: Commit Changelog
+        run: |
+          git add CHANGELOG.md
+          git add news/ || true
+          git commit -m "Release ${{ inputs.version }}"
+      - name: Push release branch
+        run: git push origin release/${{ inputs.version }}
+      - name: Create Pull Request
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh pr create \
+            --base main \
+            --head release/${{ inputs.version }} \
+            --title "Release ${{ inputs.version }}" \
+            --body "This PR contains the changelog for version ${{ inputs.version }}.
+
+          Once merged, a tag \`v${{ inputs.version }}\` will be automatically created and a GitHub release will be published."
+  create-tag-and-release:
+    if: github.event_name == 'pull_request' && github.event.pull_request.merged == true && startsWith(github.head_ref, 'release/') && github.event.pull_request.user.login
+      == 'github-actions[bot]'
     runs-on: ubuntu-latest
     environment: release
     permissions:
@@ -26,19 +83,25 @@ jobs:
         uses: astral-sh/setup-uv@v6
         with:
           version-file: pyproject.toml
-      - name: Install project
-        run: uv sync --all-groups
+      - name: Extract version from branch name
+        id: extract_version
+        run: |
+          VERSION="${{ github.head_ref }}"
+          VERSION="${VERSION#release/}"
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+      - name: Create and Push Tag
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git tag -a "v${{ steps.extract_version.outputs.version }}" -m "Version ${{ steps.extract_version.outputs.version }}"
+          git push origin "v${{ steps.extract_version.outputs.version }}"
       - name: Create wheel
-        run: uv build -o dist/
+        run: uv build -o dist/ .
       - name: Publish package distributions to PyPI
         uses: pypa/gh-action-pypi-publish@release/v1
-      - name: Determine version
-        run: |
-          tag="${GITHUB_REF#refs/*/}"
-          version="${tag:1}"
-          echo "RELEASE_VERSION=${version}" >> $GITHUB_ENV
       - name: Release on GitHub
         uses: softprops/action-gh-release@v2
         with:
           files: dist/*
-          name: Version ${{ env.RELEASE_VERSION }}
+          tag_name: v${{ inputs.version }}
+          name: Version ${{ inputs.version }}

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+<!-- towncrier release notes start -->
+
 ## 3.1.0
 - Support pylint 4.x
 

README.md

@@ -75,12 +75,7 @@ To setup a venv for development use
 Then use `source .venv/bin/activate` to activate your venv.
 
 ## Build and Publish
-
-This project uses `setuptools` as the dependency management and build tool.
-To publish a new release, follow these steps:
-* Update the version in the `pyproject.toml`
-* Add an entry in the changelog
-* Push a new tag like `vX.X.X` to trigger the release
+Execute the release action with the proper version.
 
 ## Support, Feedback, Contributing
 

news/.gitignore

@@ -0,0 +1 @@
+!.gitignore

news/news/+9002ce43.change.md

@@ -0,0 +1 @@
+Updated the release actions

pyproject.toml

@@ -1,6 +1,6 @@
 [build-system]
 build-backend = "setuptools.build_meta"
-requires = ["setuptools>=61"]
+requires = ["setuptools>=61", "setuptools-scm~=9.2"]
 
 [project]
 authors = [
@@ -27,6 +27,7 @@ dependencies = [
     "pylint>=3.3,<5",
 ]
 description = "A pylint plugin to ignore error codes per file."
+dynamic = ["version"]
 keywords = ["pylint", "plugin", "quality", "linter"]
 license = "MIT"
 license-files = ["LICENSE"]
@@ -36,7 +37,6 @@ maintainers = [
 name = "pylint-per-file-ignores"
 readme = "README.md"
 requires-python = ">=3.10,<4"
-version = "3.1.0"
 
 [dependency-groups]
 dev = [
@@ -51,6 +51,7 @@ dev = [
     "pyupgrade==3.21.2",
     "toml-sort==0.24.3",
     "uv==0.9.11",
+    "towncrier==25.8.0",
 ]
 test = [
     "pytest==9.0.1",
@@ -170,11 +171,41 @@ swagger_plugin_for_sphinx = ["py.typed"]
 [tool.setuptools.packages.find]
 include = ["pylint_per_file_ignores"]
 
+[tool.setuptools_scm]
+version_file = ""
+
 [tool.tomlsort]
 sort_first = ["build-system", "project", "dependency-groups"]
 sort_table_keys = true
 spaces_indent_inline_array = 4
 trailing_comma_inline_array = true
 
+[tool.towncrier]
+directory = "news"
+filename = "CHANGELOG.md"
+start_string = "<!-- towncrier release notes start -->\n"
+title_format = "## {version} ({project_date})"
+underlines = ["", "", ""]
+
+[[tool.towncrier.type]]
+directory = "removal"
+name = "Removals"
+
+[[tool.towncrier.type]]
+directory = "deprecation"
+name = "Deprecations"
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Features"
+
+[[tool.towncrier.type]]
+directory = "change"
+name = "Changes"
+
+[[tool.towncrier.type]]
+directory = "fix"
+name = "Fixes"
+
 [tool.uv]
 default-groups = []