Update package from template

Author: cottsay

.github/workflows/ci.yaml

@@ -1,31 +1,17 @@
+---
 name: Run tests
 
-on:
+on:  # yamllint disable-line rule:truthy
   push:
     branches: ['main']
   pull_request:
+  workflow_dispatch:
 
 jobs:
-  setup:
-    runs-on: ubuntu-latest
-    outputs:
-      strategy: ${{steps.load.outputs.strategy}}
-
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          repository: colcon/ci
-      - id: load
-        run: echo "::set-output name=strategy::$(echo $(cat strategy.json))"
-
   pytest:
-    needs: [setup]
-    strategy: ${{fromJson(needs.setup.outputs.strategy)}}
-    runs-on: ${{matrix.os}}
-
+    uses: colcon/ci/.github/workflows/pytest.yaml@main
+  yamllint:
+    runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-python@v2
-        with:
-          python-version: ${{matrix.python}}
-      - uses: colcon/ci@v1
+      - uses: actions/checkout@v4
+      - run: yamllint -f github .

publish-python.yaml

@@ -1,3 +1,4 @@
+---
 artifacts:
   - type: wheel
     uploads:
@@ -8,9 +9,8 @@ artifacts:
         config:
           repository: dirk-thomas/colcon
           distributions:
-            - ubuntu:bionic
             - ubuntu:focal
             - ubuntu:jammy
-            - debian:stretch
-            - debian:buster
-            - debian:bullseye
+            - ubuntu:noble
+            - debian:bookworm
+            - debian:trixie

setup.cfg

@@ -5,10 +5,7 @@ url = https://colcon.readthedocs.io
 project_urls =
     Changelog = https://github.com/colcon/colcon-ros-buildfarm/milestones?direction=desc&sort=due_date&state=closed
     GitHub = https://github.com/colcon/colcon-ros-buildfarm/
-author = Scott K Logan
-author_email = [email protected]
-maintainer = Scott K Logan
-maintainer_email = [email protected]
+author_email = Scott K Logan <[email protected]>
 classifiers =
     Development Status :: 3 - Alpha
     Environment :: Plugins
@@ -25,26 +22,26 @@ keywords = colcon
 
 [options]
 install_requires =
-  colcon-core
+    colcon-core
 packages = find:
 zip_safe = true
 
 [options.extras_require]
 test =
-  flake8>=3.6.0
-  flake8-blind-except
-  flake8-builtins
-  flake8-class-newline
-  flake8-comprehensions
-  flake8-deprecated
-  flake8-docstrings
-  flake8-import-order
-  flake8-quotes
-  pep8-naming
-  pylint
-  pytest
-  pytest-cov
-  scspell3k>=2.2
+    flake8>=3.6.0
+    flake8-blind-except
+    flake8-builtins
+    flake8-class-newline
+    flake8-comprehensions
+    flake8-deprecated
+    flake8-docstrings
+    flake8-import-order
+    flake8-quotes
+    pep8-naming
+    pylint
+    pytest
+    pytest-cov
+    scspell3k>=2.2
 
 [tool:pytest]
 filterwarnings =
@@ -54,11 +51,20 @@ filterwarnings =
     ignore:SelectableGroups dict interface is deprecated::flake8
     ignore:Using or importing the ABCs from 'collections' instead of from 'collections.abc' is deprecated::pyreadline
 junit_suite_name = colcon-ros-buildfarm
+markers =
+    flake8
+    linter
 
 [options.entry_points]
 
 [flake8]
+extend_ignore =
+    D100
+    D104
 import-order-style = google
+per-file-ignores =
+    test/**: D101,D102,D103,D104,D105,D107
+show_source = true
 
 [coverage:run]
 source = colcon_ros_buildfarm

stdeb.cfg

@@ -1,5 +1,5 @@
 [colcon-ros-buildfarm]
 No-Python2:
 Depends3: python3-colcon-core
-Suite: bionic focal jammy stretch buster bullseye
+Suite: focal jammy noble bookworm trixie
 X-Python3-Version: >= 3.6

test/spell_check.words

@@ -1,8 +1,11 @@
 apache
 buildfarm
 colcon
+https
 iterdir
+linter
 pathlib
+pycqa
 pytest
 scott
 scspell

test/test_flake8.py

@@ -1,51 +1,22 @@
-# Copyright 2016-2018 Dirk Thomas
+# Copyright 2018 Open Source Robotics Foundation, Inc.
 # Licensed under the Apache License, Version 2.0
 
-import logging
-from pathlib import Path
+import os
+import subprocess
 import sys
 
-from flake8 import LOG
-from flake8.api.legacy import get_style_guide
-
-
-# avoid debug and info messages from flake8 internals
-LOG.setLevel(logging.WARN)
+import pytest
 
 
+@pytest.mark.flake8
+@pytest.mark.linter
 def test_flake8():
-    style_guide = get_style_guide(
-        extend_ignore=['D100', 'D104'],
-        show_source=True,
-    )
-    style_guide_tests = get_style_guide(
-        extend_ignore=['D100', 'D101', 'D102', 'D103', 'D104', 'D105', 'D107'],
-        show_source=True,
-    )
+    # flake8 doesn't have a stable public API as of ver 6.1.0.
+    # See: https://flake8.pycqa.org/en/latest/user/python-api.html
+    # Calling through subprocess is the most stable way to run it.
 
-    stdout = sys.stdout
-    sys.stdout = sys.stderr
-    # implicitly calls report_errors()
-    report = style_guide.check_files([
-        str(Path(__file__).parents[1] / 'colcon_ros_buildfarm'),
-    ])
-    report_tests = style_guide_tests.check_files([
-        str(Path(__file__).parents[1] / 'test'),
-    ])
-    sys.stdout = stdout
-
-    total_errors = report.total_errors + report_tests.total_errors
-    if total_errors:  # pragma: no cover
-        # output summary with per-category counts
-        print()
-        if report.total_errors:
-            report._application.formatter.show_statistics(report._stats)
-        if report_tests.total_errors:
-            report_tests._application.formatter.show_statistics(
-                report_tests._stats)
-        print(
-            'flake8 reported {total_errors} errors'
-            .format_map(locals()), file=sys.stderr)
-
-    assert not total_errors, \
-        'flake8 reported {total_errors} errors'.format_map(locals())
+    ret_code = subprocess.call(
+        [sys.executable, '-m', 'flake8'],
+        cwd=os.path.dirname(os.path.dirname(__file__)),
+    )
+    assert 0 == ret_code, 'flake8 found violations'

test/test_spell_check.py

@@ -4,10 +4,6 @@
 from pathlib import Path
 
 import pytest
-from scspell import Report
-from scspell import SCSPELL_BUILTIN_DICT
-from scspell import spell_check
-
 
 spell_check_words_path = Path(__file__).parent / 'spell_check.words'
 
@@ -18,7 +14,12 @@ def known_words():
     return spell_check_words_path.read_text().splitlines()
 
 
+@pytest.mark.linter
 def test_spell_check(known_words):
+    from scspell import Report
+    from scspell import SCSPELL_BUILTIN_DICT
+    from scspell import spell_check
+
     source_filenames = [Path(__file__).parents[1] / 'setup.py'] + \
         list(
             (Path(__file__).parents[1] / 'colcon_ros_buildfarm')
@@ -36,21 +37,23 @@ def test_spell_check(known_words):
 
     unknown_word_count = len(report.unknown_words)
     assert unknown_word_count == 0, \
-        'Found {unknown_word_count} unknown words: '.format_map(locals()) + \
+        f'Found {unknown_word_count} unknown words: ' + \
         ', '.join(sorted(report.unknown_words))
 
     unused_known_words = set(known_words) - report.found_known_words
     unused_known_word_count = len(unused_known_words)
     assert unused_known_word_count == 0, \
-        '{unused_known_word_count} words in the word list are not used: ' \
-        .format_map(locals()) + ', '.join(sorted(unused_known_words))
+        f'{unused_known_word_count} words in the word list are not used: ' + \
+        ', '.join(sorted(unused_known_words))
 
 
+@pytest.mark.linter
 def test_spell_check_word_list_order(known_words):
     assert known_words == sorted(known_words), \
         'The word list should be ordered alphabetically'
 
 
+@pytest.mark.linter
 def test_spell_check_word_list_duplicates(known_words):
     assert len(known_words) == len(set(known_words)), \
         'The word list should not contain duplicates'