Skip to content

Commit f8ca1bc

Browse files
committed
📝 Document options in the README
1 parent 137a1f8 commit f8ca1bc

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,15 @@
33
A GitHub Action to unpack a source distribution package (tarball / `.tar.gz`) into the current workspace
44

55

6+
## Options
7+
8+
This action only has two inputs — `source-tarball-name` (default:
9+
`*.tar.gz`) and `workflow-artifact-name` (default:
10+
`python-package-distributions`). It downloads the latter and works with
11+
the sdist matching the former glob to make its contents available in the
12+
current working directory.
13+
14+
615
## Any users?
716

817
At the moment, it is used by the [@CherryPy] upstream, more to come.

0 commit comments

Comments
 (0)