Just like for the action run adding annotations, the CI is the place
where you'd want extra information.
Especially information that tells you *how* to fix an issue, which is
relevant when a contributor doesn't want to / can't run the tool locally
(an edit through the GitHub UI could be more convenient, don't want to
bother installing extra tools locally, they're having issues not picking
up the right Ruff version when ran locally, etc.)
It's also easier to opt-out of copy-pasting this flag, than not knowing
about it in the first place.
Hence I think this documentation change is a positive to help anyone
integrate this action into their CI for check+formatting by looking at
the readme.
I'd quite like to use `ruff-action`'s auto-detection feature, but it
currently doesn't read the `[project.optional-dependency]` table, and
support for the PEP 735 `[dependency-groups]` table is currently limited
to only the special-cased `dev` key, and does not account for the
possibility of `{include-group="..."}` inline tables, as [described by
the PEP](https://peps.python.org/pep-0735/#dependency-group-include).
I have guessed how to make the tests work, as the only JS development I
do is plain JS (sans frameworks), so TypeScript is still quite new to me
-- feel free to push required changes to this branch.
A
Closes: #9
Changes the default behavior to:
- Search for a pyproject.toml in the repo root
- Search in project.dependencies and dependency-groups.dev for ruff
- If none is found use latest
Support for requirements.txt files can be added later
# Summary
Converts the action from a [composite to
javascript](https://docs.github.com/en/actions/sharing-automations/creating-actions/about-custom-actions#types-of-actions).
Most importantly to make use of prebuilt libraries and helpers like
[actions/toolkit](https://github.com/actions/toolkit).
The structure and features are modeled after
[astral-sh/setup-uv](https://github.com/astral-sh/setup-uv)
## Changes
1. Download the ruff executable for the current platform from the GitHub
releases
2. Add ruff to the PATH
3. Validate the downloaded ruff executable against its checksum
4. Cache ruff in the [Tool
Cache](https://github.com/actions/toolkit/tree/main/packages/tool-cache)
to speed up runs on self-hosted runners
5. Support semver ranges to define the ruff version to install
## 🚨 Breaking changes
Removes the `changed-files` input.
This input could previously be used to run ruff only on files changed in
a PR. The functionality was implemented by calling another action. This
repo should focus on providing a quick and easy way to use ruff in
GitHub Actions, not add more functionality on top of ruff.
The previous functionality can be replicated with:
```yaml
- uses: actions/checkout@v4
- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v45
with:
files: |
**.py
- name: Run ruff on changed files only
uses: astral-sh/ruff-action@v2
with:
src: ${{ steps.changed-files.outputs.all_changed_files }}
```
This was tested here:
https://github.com/astral-sh/ruff-action/actions/runs/12017035736/job/33498508269
Kevin Stillhammer