Merge pull request #200 from nicoddemus/improved-ci

Improve CI and move to src layout

Author: nicoddemus

.gitattributes

@@ -0,0 +1,2 @@
+# restructured text files forced to LF because of doc8 pre-commit hook.
+*.rst eol=lf

.github/workflows/deploy.yml

@@ -0,0 +1,49 @@
+name: deploy
+
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Release version'
+        required: true
+        default: '1.2.3'
+
+jobs:
+
+  package:
+    runs-on: ubuntu-latest
+    env:
+      SETUPTOOLS_SCM_PRETEND_VERSION: ${{ github.event.inputs.version }}
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Build and Check Package
+      uses: hynek/[email protected]
+
+  deploy:
+    needs: package
+    runs-on: ubuntu-latest
+    environment: deploy
+    permissions:
+      id-token: write  # For PyPI trusted publishers.
+      contents: write  # For tag.
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Download Package
+      uses: actions/download-artifact@v3
+      with:
+        name: Packages
+        path: dist
+
+    - name: Publish package to PyPI
+      uses: pypa/[email protected]
+
+    - name: Push tag
+      run: |
+        git config user.name "pytest bot"
+        git config user.email "[email protected]"
+        git tag --annotate --message=v${{ github.event.inputs.version }} v${{ github.event.inputs.version }} ${{ github.sha }}
+        git push origin v${{ github.event.inputs.version }}

.github/workflows/main.yml

@@ -0,0 +1,63 @@
+name: test
+
+on:
+  push:
+    branches:
+      - "master"
+      - "test-me-*"
+
+  pull_request:
+    branches:
+      - "master"
+
+# Cancel running jobs for the same workflow and branch.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  package:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Build and Check Package
+      uses: hynek/[email protected]
+
+  test:
+
+    needs: [package]
+
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ windows-latest, ubuntu-latest ]
+        python: [ "3.7","3.8","3.10","3.11", "pypy-3.7" ]
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        fetch-depth: 0
+
+    - name: Download Package
+      uses: actions/download-artifact@v3
+      with:
+        name: Packages
+        path: dist
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python }}
+
+    - name: Install tox
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: Test
+      shell: bash
+      run: |
+        tox run -e py --installpkg `find dist/*.tar.gz`

.github/workflows/test.yml

@@ -1,7 +1,6 @@
 doc/_build
 build/
-execnet.egg-info/
-execnet/_version.py
+src/execnet/_version.py
 dist/
 .pytest_cache/
 .eggs/

.gitignore

@@ -13,8 +13,8 @@ Important
 .. image:: https://img.shields.io/pypi/pyversions/execnet.svg
     :target: https://pypi.org/project/execnet/
 
-.. image:: https://github.com/pytest-dev/execnet/workflows/build/badge.svg
-    :target: https://github.com/pytest-dev/execnet/actions?query=workflow%3Abuild
+.. image:: https://github.com/pytest-dev/execnet/workflows/test/badge.svg
+    :target: https://github.com/pytest-dev/execnet/actions?query=workflow%3Atest
 
 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
     :target: https://github.com/python/black
@@ -30,7 +30,7 @@ a minimal and fast API targeting the following uses:
 * write scripts to administer multiple hosts
 
 Features
-------------------
+--------
 
 * zero-install bootstrapping: no remote installation required!
 

README.rst

@@ -26,12 +26,8 @@ To publish a new release ``X.Y.Z``, the steps are as follows:
 
 #. Update the ``CHANGELOG.rst`` file with the new release information.
 
-#. Commit and push the branch for review.
+#. Commit and push the branch to ``upstream`` and open a PR.
 
-#. Once PR is **green** and **approved**, create and push a tag::
+#. Once the PR is **green** and **approved**, start the ``deploy`` workflow manually from the branch ``release-VERSION``, passing ``VERSION`` as parameter.
 
-    $ export VERSION=X.Y.Z
-    $ git tag v$VERSION release-$VERSION
-    $ git push [email protected]:pytest-dev/execnet.git v$VERSION
-
-That will build the package and publish it on ``PyPI`` automatically.
+#. Merge the release PR to ``master``.

RELEASING.rst

@@ -9,7 +9,7 @@ build-backend = "hatchling.build"
 name = "execnet"
 dynamic = ["version"]
 description = "execnet: rapid multi-Python deployment"
-long_description_file = "README.rst"
+readme = {"file" = "README.rst", "content-type" = "text/x-rst"}
 license = "MIT"
 requires-python = ">=3.7"
 authors = [
@@ -49,11 +49,11 @@ Homepage = "https://execnet.readthedocs.io/en/latest/"
 source = "vcs"
 
 [tool.hatch.build.hooks.vcs]
-version-file = "execnet/_version.py"
+version-file = "src/execnet/_version.py"
 
 [tool.hatch.build.targets.sdist]
 include = [
-    "/execnet",
+    "/src/execnet",
 ]