Merge pull request #734 from cjmayo/releases

Release Improvements

.github/workflows/build.yml

@@ -85,7 +85,7 @@ jobs:
         run: |
           python -m pip install -U pip
           python -m pip install -U hatchling hatch-vcs polib
-          python -m pip install -U tox coveralls
+          python -m pip install -U tox
 
       - name: Wait for ClamAV to be ready
         run: |
@@ -97,10 +97,7 @@ jobs:
             python -m tox -e ${{ matrix.toxenv }}
 
       - name: Report to coveralls
-        run: coveralls
-        env:
-          COVERALLS_SERVICE_NAME: github
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        uses: coverallsapp/github-action@f350da2c033043742f89e8c0b7b5145a1616da6d
 
   docs:
     # there's some overlap with publish-pages.yml, but this one runs on pull

.github/workflows/release-files.yml

@@ -9,6 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     permissions:
       contents: write
+      id-token: write
 
     steps:
       - uses: actions/checkout@v3
@@ -50,3 +51,6 @@ jobs:
             gh release upload ${{ github.ref_name }} dist/*
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+
+      - name: Publish distribution files to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

README.rst

@@ -32,6 +32,8 @@ Python 3.8 or later is needed. Using pip to install LinkChecker:
 
 ``pip3 install linkchecker``
 
+pipx can also be used to install LinkChecker.
+
 The version in the pip repository may be old, to find out how to get the latest
 code, plus platform-specific information and other advice see `doc/install.txt`_
 in the source code archive.

doc/development.md

@@ -74,6 +74,4 @@ Release process
 
 5. create release (vX.Y.Z) on GitHub
 
-6. download Python distribution files from the GitHub release
-
-7. check distribution files (`twine check LinkChecker*`) and upload to PyPI (`twine upload LinkChecker*`)
+6. check release has been created on PyPI

doc/install.txt

@@ -37,22 +37,29 @@ used.
 
 .. _venv: https://docs.python.org/3/library/venv.html#creating-virtual-environments
 
-Setup with pip
+Setup with pip(x)
 ------------------
-pip_ can be used to install LinkChecker on the local system.
+pip_ or pipx_ can be used to install LinkChecker on the local system.
 
 To install the latest release from PyPI:
 ``pip3 install linkchecker``
 
-Alternatively you can install the latest source from the LinkChecker GitHub repository.
+or:
+``pipx install linkchecker``
+
+There is no need to wait for releases, every update to LinkChecker gets a unique
+version number and is subjected to the test suite.
+You can easily install the latest source from the LinkChecker GitHub repository.
 First, if you want application translations:
 ``pip3 install polib``
 
 Then:
-``pip3 install git+https://github.com/linkchecker/linkchecker.git``
+``pip3 install https://github.com/linkchecker/linkchecker/archive/master.tar.gz``
 
 .. _pip: https://pypi.org/project/pip/
 
+.. _pipx: https://pypi.org/project/pipx/
+
 Setup for Windows
 -----------------
 Python from the Microsoft Store does include pip_, but installing
@@ -68,9 +75,9 @@ https://pip.pypa.io/en/stable/installation/
 Setup for GNU/Linux
 -------------------
 On all major Linux distributions (Debian, Mandriva, Redhat, Suse, Ubuntu),
-the ``linkchecker`` package is available for installation. pip_ will be
-available, often as a package e.g. ``python3-pip``, to install the latest
-LinkChecker.
+the ``linkchecker`` package is available for installation.
+To install the latest LinkChecker pip_ will be available, often as a package
+e.g. ``python3-pip``, a pipx_ package may also be found e.g. ``pipx``.
 
 You may wish to install your distribution's copies of LinkChecker's dependencies
 before using pip to install LinkChecker. e.g. for Debian/Ubuntu:
@@ -79,6 +86,10 @@ before using pip to install LinkChecker. e.g. for Debian/Ubuntu:
 
 If those packages are too old pip will install newer versions.
 
+To use the dependencies from your distribution if installing LinkChecker with pipx:
+
+`'pipx install --system-site-packages linkchecker``
+
 Manual setup for Unix systems
 -----------------------------
 First, install the required software.