chore: update release process to used trusted publishing (#9)

Author: bdraco

.github/workflows/ci.yml

@@ -6,15 +6,30 @@ on:
       - main
   pull_request:
 
+concurrency:
+  group: ${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
 jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
-          python-version: "3.11"
-      - uses: pre-commit/action@v2.0.3
+          python-version: 3.x
+      - uses: pre-commit/action@v3.0.0
+
+  # Make sure commit messages follow the conventional commits convention:
+  # https://www.conventionalcommits.org
+  commitlint:
+    name: Lint Commit Messages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v5.4.4
 
   test:
     strategy:
@@ -28,57 +43,63 @@ jobs:
           - ubuntu-latest
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - uses: snok/install-poetry@v1
+      - uses: snok/install-poetry@v1.3.4
       - name: Install Dependencies
         run: poetry install
+        shell: bash
       - name: Test with Pytest
-        run: poetry run pytest --cov=./aiosteamist --cov-report=xml --cov-report=term-missing tests/test_init.py
+        run: poetry run pytest --cov-report=xml
+        shell: bash
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
 
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.9"
-      - uses: snok/install-poetry@v1
-      - name: Install Dependencies
-        run: poetry install -E docs
-      - name: Build docs
-        working-directory: docs
-        run: poetry run make html
-
   release:
-    runs-on: ubuntu-latest
-    environment: release
-    if: github.ref == 'refs/heads/main'
     needs:
       - test
       - lint
+      - commitlint
+
+    runs-on: ubuntu-latest
+    environment: release
+    concurrency: release
+    permissions:
+      id-token: write
+      contents: write
 
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
+          ref: ${{ github.head_ref || github.ref_name }}
+
+      # Do a dry run of PSR
+      - name: Test release
+        uses: python-semantic-release/python-semantic-release@v8.7.2
+        if: github.ref_name != 'main'
+        with:
+          root_options: --noop
+
+      # On main branch: actual PSR + upload to PyPI & GitHub
+      - name: Release
+        uses: python-semantic-release/python-semantic-release@v8.7.2
+        id: release
+        if: github.ref_name == 'main'
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: steps.release.outputs.released == 'true'
 
-      # Run semantic release:
-      # - Update CHANGELOG.md
-      # - Update version in code
-      # - Create git tag
-      # - Create GitHub release
-      # - Publish to PyPI
-      - name: Python Semantic Release
-        uses: relekang/python-semantic-release@v7.34.3
+      - name: Publish package distributions to GitHub Releases
+        uses: python-semantic-release/upload-to-gh-release@main
+        if: steps.release.outputs.released == 'true'
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          pypi_token: ${{ secrets.PYPI_TOKEN }}

.pre-commit-config.yaml

@@ -9,32 +9,58 @@ ci:
 
 repos:
   - repo: https://github.com/commitizen-tools/commitizen
-    rev: v2.27.1
+    rev: v2.37.0
     hooks:
       - id: commitizen
         stages: [commit-msg]
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.4.0
     hooks:
-      - id: trailing-whitespace
-      - id: end-of-file-fixer
-      - id: check-yaml
+      - id: debug-statements
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
       - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
       - id: debug-statements
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v2.7.1
+    hooks:
+      - id: prettier
+        args: ["--tab-width", "2"]
   - repo: https://github.com/asottile/pyupgrade
-    rev: v2.34.0
+    rev: v3.2.2
     hooks:
       - id: pyupgrade
         args: [--py37-plus]
   - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+    rev: 5.13.0
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: 22.3.0
+    rev: 22.10.0
     hooks:
       - id: black
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.2
+    hooks:
+      - id: codespell
   - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+    rev: 6.0.0
     hooks:
       - id: flake8
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.931
+    hooks:
+      - id: mypy
+        additional_dependencies: []
+  - repo: https://github.com/PyCQA/bandit
+    rev: 1.7.4
+    hooks:
+      - id: bandit
+        args: [-x, tests]

CONTRIBUTING.md

@@ -12,9 +12,9 @@ Report bugs at <https://github.com/bdraco/aiosteamist/issues>.
 
 If you are reporting a bug, please include:
 
--   Your operating system name and version.
--   Any details about your local setup that might be helpful in troubleshooting.
--   Detailed steps to reproduce the bug.
+- Your operating system name and version.
+- Any details about your local setup that might be helpful in troubleshooting.
+- Detailed steps to reproduce the bug.
 
 ### Fix Bugs
 
@@ -34,9 +34,9 @@ The best way to send feedback is to file an issue at <https://github.com/bdraco/
 
 If you are proposing a feature:
 
--   Explain in detail how it would work.
--   Keep the scope as narrow as possible, to make it easier to implement.
--   Remember that this is a volunteer-driven project, and that contributions are welcome :)
+- Explain in detail how it would work.
+- Keep the scope as narrow as possible, to make it easier to implement.
+- Remember that this is a volunteer-driven project, and that contributions are welcome :)
 
 ## Get Started!
 

README.md

@@ -30,7 +30,6 @@
   <img src="https://img.shields.io/pypi/l/aiosteamist.svg?style=flat-square" alt="License">
 </p>
 
-
 Control Steamist steam systems
 
 ## Installation
@@ -48,6 +47,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <!-- markdownlint-enable -->
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

aiosteamist/__init__.py

@@ -23,7 +23,7 @@
 STEAM_ON_LED = 6
 STEAM_OFF_LED = 7
 
-NEVER_TIME = -1200
+NEVER_TIME = -1200.0
 
 
 @dataclass
@@ -50,7 +50,7 @@ def __init__(
         self._timeout = timeout
         self._host = host
         self._auth_invalid = 0
-        self._url = URL(f"http://{self._host}")
+        self._url = URL(f"http://{self._host}")  # noqa
 
     async def _get(self, endpoint: str, params=None) -> str:
         """Make a get request."""

docs/source/changelog.md

@@ -1,2 +1,3 @@
 ```{include} ../../CHANGELOG.md
+
 ```

docs/source/conf.py

@@ -13,7 +13,7 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
-
+from typing import Any, List
 
 # -- Project information -----------------------------------------------------
 
@@ -40,7 +40,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns: List[Any] = []
 
 
 # -- Options for HTML output -------------------------------------------------

docs/source/contributing.md

@@ -1,2 +1,3 @@
 ```{include} ../../CONTRIBUTING.md
+
 ```

docs/source/index.md

@@ -17,4 +17,5 @@ contributing
 ```
 
 ```{include} ../../README.md
+
 ```

pyproject.toml

@@ -51,10 +51,13 @@ pytest-asyncio = ">=0.23.4"
 
 [tool.semantic_release]
 branch = "main"
-version_toml = "pyproject.toml:tool.poetry.version"
-version_variable = "aiosteamist/__init__.py:__version__"
+version_toml = ["pyproject.toml:tool.poetry.version"]
+version_variables = [
+    "src/aiosteamist/__init__.py:__version__",
+]
 build_command = "pip install poetry && poetry build"
 
+
 [tool.pytest.ini_options]
 addopts = "-v -Wdefault --cov=aiosteamist"