Merge pull request #210 from ASFHyP3/develop

Release v0.13.1

.github/workflows/reusable-ruff.yml

@@ -18,7 +18,7 @@ jobs:
           python -m pip install ruff
 
       - name: Ruff linting check
-        run: ruff check --select I --output-format=github . || echo 'To automatically fix errors, run `ruff check --select I --fix .`'
+        run: ruff check --output-format=github . || echo 'To automatically fix errors, run `ruff check --fix .`'
 
       - name: Ruff format check
         run: ruff format --diff . || echo 'To automatically fix errors, run `ruff format .`'

CHANGELOG.md

@@ -6,6 +6,11 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [PEP 440](https://www.python.org/dev/peps/pep-0440/) 
 and uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.13.1]
+
+### Changed
+- Reverts the addition of `--select I` to [`reusable-ruff`](.github/workflows/reusable-ruff.yml), as this option is already included in the recommended `pyproject.toml` settings given in the README.
+
 ## [0.13.0]
 
 ### Changed

README.md

@@ -230,12 +230,22 @@ jobs:
     uses: ASFHyP3/actions/.github/workflows/[email protected]
 ```
 
-to ensure the Python code is styled correctly.
+Make sure that `pyproject.toml` contains the appropriate Python version specifier
+(see the [ruff docs](https://docs.astral.sh/ruff/settings/#target-version)), e.g:
+
+```toml
+[project]
+requires-python = ">=3.13"
+```
+
+To conform to ASFHyP3's Python style add the following to `pyproject.toml`
+(and update the `src =` line as needed, for import ordering):
 
-To conform to ASFHyP3's Python style add the following to your project's `pyproject.toml`:
 ```toml
 [tool.ruff]
 line-length = 120
+# The directories to consider when resolving first- vs. third-party imports.
+# See: https://docs.astral.sh/ruff/settings/#src
 src = ["src", "tests"]
 
 [tool.ruff.format]
@@ -259,12 +269,6 @@ case-sensitive = true
 lines-after-imports = 2
 ```
 
-Ruff can automatically fix many linting errors and reformat code to match your Python style by running these  commands:
-```shell
-ruff check --fix .
-ruff format .
-```
-
 ### [`reusable-git-object-name.yml`](./.github/workflows/reusable-git-object-name.yml)
 
 Outputs the human-readable git object name from [`git describe --dirty --tags --long --match "*[0-9]*"`](https://git-scm.com/docs/git-describe)