Merge pull request #30 from twisted/release-25.2

Release 25.2

Author: adiroiban

.github/workflows/github-deploy.yml

@@ -2,9 +2,14 @@ name: Build and upload to PyPI
 on:
   push:
     branches:
-      - default
-    tags:
-      - v*
+      - trunk
+    # To simplify the release process, the publishing is triggered on tag.
+    # We should make sure to only push tags for new releases.
+    # If we start using tags for non-release purposes,
+    # this needs to be updated.
+    #
+    # We need to explicitly configure an expression that matches anything.
+    tags: [ "**" ]
   pull_request:
 
 jobs:
@@ -75,12 +80,11 @@ jobs:
           path: dist/*.tar.gz
 
   upload_pypi:
-    needs: [build_wheels, build_sdist]
+    needs: [build_wheels, build_sdist, check_manifest]
     runs-on: ubuntu-latest
-    # upload to PyPI on every tag starting with 'v'
-    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
-    # alternatively, to publish when a GitHub Release is created, use the following rule:
-    # if: github.event_name == 'release' && github.event.action == 'published'
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
     steps:
       - uses: actions/download-artifact@v4
         with:
@@ -91,8 +95,7 @@ jobs:
       - name: Check files
         run: ls -al dist/
 
-      - uses: pypa/gh-action-pypi-publish@master
-        with:
-          user: __token__
-          password: ${{ secrets.pypi_password }}
-          # To test: repository_url: https://test.pypi.org/legacy/
+      - name: Publish to PyPI - on tag
+        # Skip upload to PyPI if we don't have a tag
+        if: startsWith(github.ref, 'refs/tags/')
+        uses: pypa/gh-action-pypi-publish@release/v1

CHANGELOG.rst

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+
+25.2.0 (2025-02-27)
+-------------------
+
+- Add support for Python 3.13 wheels.
+- Add support for Python 3.13 free threading wheels.
+
+
 1.0.4 (2023-08-10)
 ------------------
 

MANIFEST.in

@@ -9,4 +9,5 @@ include LICENSE
 exclude CHANGELOG.rst
 exclude CONTRIBUTING.rst
 exclude SECURITY.md
+exclude RELEASE.rst
 exclude .pre-commit-config.yaml

RELEASE.rst

@@ -0,0 +1,46 @@
+How to do a release
+###################
+
+We use calendar versioning, similar to the `twisted/twisted` project.
+
+To do a release, follow these steps:
+
+* Create a new branch. You can name the branch `release-YEAR.MONTH`.
+* Update the `[metadata] version` inside `setup.cfg`
+* Update the `Changelog.rst` file with the summary of the changes.
+* Commit the changes to GitHub and create a PR
+* Request the review from `twisted-contributors` team.
+* Once the PR is approved, create a new release via `GitHub Releases<https://github.com/twisted/twisted-iocpsupport/releases/new>`_.
+  The tag name should be the current version. Select to create a new tag.
+  Select the release branch as the target branch.
+  Copy/paste the release notes.
+* Publish the release.
+  This will automatically trigger that creation of a new that,
+  which in turn will trigger the build process for the wheels and will
+  publish them to PyPI.
+
+Using GitHub Releases is not required.
+You can also just create and push a new tag.
+It will still trigger the publish process.
+
+GitHub Release should just make it a bit easier to detect the release of this project.
+
+
+Implementation details
+======================
+
+To publish to PyPi, the GitHub Action workflow needs to be named `github-deploy.yml`.
+You can `reconfigure this via PyPi <https://pypi.org/manage/project/twisted-iocpsupport/settings/publishing/>`_.
+
+The binary wheels are generated using `cibuildwheel`.
+To build wheels for newer Python version you might need to update the version
+of `cibuildwheel`.
+
+To disable building binaries for older Python version you might need to
+edit the `[tool.cibuildwheel]` section from the `pyproject.toml` file.
+
+GitHub Action is used to run `cibuildwheel` to generate the wheels on any
+commit pushed to the main branch, to a PR or a tag.
+
+Any tag pushed that has a name starting with `v` will trigger the publishing
+to the production PyPI site.

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = twisted-iocpsupport
-version = 1.0.4
+version = 25.2.0
 description = An extension for use in the twisted I/O Completion Ports reactor.
 long_description = file: README.rst
 long_description_content_type = text/x-rst