Skip to content

Commit 3853679

Browse files
committed
chore: update readme
1 parent 885117a commit 3853679

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ This action aims to help you eliminate (or at least reduce) the amount of custom
1212
- **root-dir**: Directory root for where to begin recursively searching for projects.
1313
Python projects contained in this directory or lower will be discovered. Defaults to your repository's root directory.
1414

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".
1516

1617
## Outputs
1718
- **paths**: JSON array of found project path strings
@@ -39,6 +40,8 @@ These are the fields for `project` objects in the output:
3940
- **commands**: Object with keys for each discovered command and the shell command as the value.
4041
This is dynamically constructed from the `pyproject.toml` content.
4142

43+
- **exports**: Object with keys specified by the `additional-export-paths` input, and the structured TOML data (parsed as JSON) as the values.
44+
4245

4346
## Project Commands
4447
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.
@@ -79,4 +82,4 @@ https://stackoverflow.com/questions/70386944/how-should-poetry-scripts-used-in-t
7982
https://github.com/python-poetry/poetry/issues/3386
8083

8184
## Example Workflow
82-
[.github/workflows/examples/example.yml](.github/workflows/examples/example.yml)
85+
[.github/workflows/examples/example.yml](.github/workflows/examples/example.yml)

dist/index.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/index.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)