Skip to content

Commit 04ccb94

Browse files
ajaxbitsajaxbits
committed
chore: update readme
1 parent 9bf05fd commit 04ccb94

File tree

1 file changed

+21
-13
lines changed

1 file changed

+21
-13
lines changed

‎README.md‎

Lines changed: 21 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,22 +7,32 @@ This is meant to faciliate downstream actions or workflows such as matrix builds
77

88
This action aims to help you eliminate (or at least reduce) the amount of customization needed in your GHA workflows by pushing your project-specific stuff into `pyproject.toml`.
99

10-
1110
## Inputs
12-
- **root-dir**: Directory root for where to begin recursively searching for projects.
13-
Python projects contained in this directory or lower will be discovered. Defaults to your repository's root directory.
14-
15-
- **additional-export-paths**: Additional TOML keys to export as part of the projects object. Specify them as json path strings, separated by commas. For example, "tool.foo.bar,baz.qux".
1611

17-
## Outputs
18-
- **paths**: JSON array of found project path strings
12+
> `List` type is a newline-delimited string
13+
> ```yaml
14+
> exclude-commands: |
15+
> project=my-package-1,command=test
16+
> project=my-package-2,command=lint
17+
> ```
1918
20-
- **projects**: JSON array of all found projects ([project object](#project-object-output-shape))
19+
> `CSV` type is a comma-delimited string
20+
> ```yaml
21+
> additional-export-paths: tool.foo.bar,baz.qux
22+
> ```
2123
22-
- **projects-by-command**: JSON object with keys corresponding to the name of discovered commands
23-
(eg `install`, `test`, `package`, etc.) in all projects, with an array value containing each
24-
[project object](#project-object-output-shape) that implements the command.
24+
| Input | Type | Description |
25+
|---------------------------|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
26+
| `root-dir` | string | Directory root for where to begin recursively searching for projects. Python projects contained in this directory or lower will be discovered. Defaults to your repository's root directory. |
27+
| `additional-export-paths` | CSV | Additional TOML keys to export as part of the projects object. Specify them as JSON path strings, separated by commas. For example, `"tool.foo.bar,baz.qux"`. |
28+
| `exclude-commands` | string/List | Commands to exclude from processing during project discovery. Any plain string will be parsed as a command. For instance, passing "test" will cause the action to not export any information about "test" commands found in the repo. For project-specific overrides, pass a string of form `project=<name>,command=<name>`. For instance, a value of `project=one,command=lint` would cause the `lint` command to be excluded for a project named `one`, if such a project is discovered. Global and project-specific excludes can be freely mixed. |
2529
30+
## Outputs
31+
| Output | Type | Description |
32+
|-----------------------|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
33+
| `paths` | JSON array<string> | JSON array of found project path strings. |
34+
| `projects` | JSON array<project> | JSON array of all found projects (see [project object](#project-object-output-shape)). |
35+
| `projects-by-command` | JSON object<string, project[]> | JSON object with keys corresponding to the name of discovered commands (e.g., `install`, `test`, `package`, etc.) in all projects, with an array value containing each [project object](#project-object-output-shape) that implements the command. |
2636
2737
## Project object output shape
2838
These are the fields for `project` objects in the output:
@@ -42,7 +52,6 @@ This is dynamically constructed from the `pyproject.toml` content.
4252
4353
- **exports**: Object with keys specified by the `additional-export-paths` input, and the structured TOML data (parsed as JSON) as the values.
4454
45-
4655
## Project Commands
4756
In the absence of Python standards for expressing internal project CI/CD/Dev operations, this action tries to unify the various known ways in the wild.
4857
@@ -71,7 +80,6 @@ can leverage a task runner tool like [Poe](https://github.com/nat-n/poethepoet)
7180
7281
*If Poetry ever adds support for internal project (CI/CD/Dev) commands separate from published commands, then it will be added to this action.*
7382
74-
7583
### Relevant References / Discussions
7684
https://discuss.python.org/t/a-new-pep-to-specify-dev-scripts-and-or-dev-scripts-providers-in-pyproject-toml/11457
7785

0 commit comments

Comments
 (0)