Actions v0.21.0

Added

• A reusable-pypi workflow to build source and binary distributions of Python package and distribute them on PyPI.org.

Actions v0.20.0

Added

• The reusable-docker-ecr.yml workflow now accepts a file input for specifying the name of the dockerfile to build.

Changed

• The update-examples.yml workflow no longer used the reusable-git-object-name.yml workflow.

• The reusable-docker-ecr.yml and reusable-docker-ghcr.yml workflows have changed substantially! These workflows are now version-centric instead of branch-centric and their usage has changed. Please make these changes to any calling workflow:

   on:
     push:
       branches:
  -      - main
         - develop
  +    tags:
  +      - 'v*'
     pull_request:
       branches:
         - main
         - develop

  and:

       uses: ASFHyP3/actions/.github/workflows/reusable-docker-ghcr.yml@v0.19.0
       ...
       with:
  -      release_branch: main
  -      develop_branch: develop
         ...

  For current usage, see the README and for more details about these changes, see #288.

Fixed

• latest tag will now be applied to release-tagged Docker images correctly. Fixes #278

Removed

• The reusable-git-object-name.yml workflow has been removed. We recommend using the reusable-version-info.yml workflow instead.

Actions v0.19.0

Added

• Added an optional runner input for reusable-ruff and reusable-mypy to allow specifying a custom GitHub Actions runner. Helps to address ASFHyP3/hyp3-testing#128

Actions v0.18.1

Added

• Added permissions field for every job in the README examples to address #220

Changed

• Changed the default value for the reusable-release.yml workflow's sync_pr_label input from tools-bot to bumpless.

Fixed

• Removed unnecessary actions/checkout step from reusable-release-checklist-comment.yml so that it does not require the contents: read permission for private repos.
• Replaced the conda_env_name input parameter with python_version for the reusable-version-info job in the docker build README examples.
• The use or requirements of GitHub issue/pull request labels in the reusable workflows are now described in the README.

Actions v0.18.0

Added

• Added notes to our ruff documentation on how to relax the rules for docstrings and type annotations.
• Added a disclaimer to our mypy documentation regarding the limitations of using a static type checker on Python code.
• Added a note about how the check_untyped_defs option included in our recommended mypy settings differs from mypy's default static vs. dynamic typing behavior.

Changed

• Updated our recommended ruff settings to suppress type annotation warnings for dummy function parameters (e.g. _) and ignore all D1 rules (missing docstring warnings) for tests/:

  +[tool.ruff.lint.flake8-annotations]
  +suppress-dummy-args = true
  +
   [tool.ruff.lint.extend-per-file-ignores]
  -"tests/*" = ["D100", "D103", "ANN"]
  +"tests/*" = ["D1", "ANN"]

Fixed

• The link to our Mypy wiki article is now publicly accessible.

Actions v0.17.1

Fixed

• Fixed ruff: command not found bug in reusable-ruff, introduced by the previous release.

Actions v0.17.0

Changed

• The reusable-ruff workflow now runs inside a mamba environment and assumes the presence of an environment.yml file.

• We now recommend pinning to an exact version for both ruff and mypy in your project dependencies, to avoid unexpected static analysis errors due to unpinned dependency upgrades.

• We now recommend adding the following lines to pyproject.toml, to bring our recommended ruff settings in line with hyp3-cookiecutter:

  [tool.ruff.lint.extend-per-file-ignores]
  "tests/*" = ["D100", "D103", "ANN"]

Actions v0.16.0

Changed

• The reusable-ruff workflow will now run the ruff format step whether or not the ruff check step failed.

Actions v0.15.0

Removed

• The reusable-mypy workflow no longer passes any optional arguments to the mypy command. This makes it easier to run mypy locally, because the command is just:

  mypy .
  

  If you want to preserve the removed options for your project, you must now add them to [tool.mypy] in pyproject.toml:

  install_types = true
  non_interactive = true
  pretty = true
  ignore_missing_imports = true

  Note that we discourage enabling ignore_missing_imports as a global option (see #225). You can always find our currently recommended configuration options in the README.

Actions v0.14.0

Added

• reusable-mypy reusable workflow for performing static type checking with mypy.
• reusable-ruff now prints the suggested commands for automatically fixing errors.

Removed

• reusable-flake8.yml has been removed. We recommend reusable-ruff instead.