Skip to content

docs: clarify GitHub Action pyproject.toml version lookup for Poetry users #5240

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pctablet505 wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −0
Open

docs: clarify GitHub Action pyproject.toml version lookup for Poetry users #5240

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/integrations/github_actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,13 @@ To read the version from the `pyproject.toml` file instead, set `use_pyproject`
`project.optional-dependencies` table. Note that this requires Python >= 3.11, so using
the setup-python action may be required, for example:

```{note}
This action only reads version specifiers from standard `pyproject.toml` locations.
Poetry-specific dependency tables such as `tool.poetry.dependencies` are not parsed.
If you manage `black` with Poetry, set `tool.black.required-version` or use the
`version` input.
```

**Security note:** `use_pyproject` only accepts standard version specifiers for `black`
(for example `==`, `~=`, `>=` and ranges like `>=25,<26`). Direct references such as
`black @ https://...` are not supported. If your workflow runs on untrusted pull
Expand Down
Loading