Skip to content

Commit 374aa54

Browse files
committed
Document job summaries
1 parent 1d8e882 commit 374aa54

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
@@ -126,6 +126,15 @@ After a successful run, you’ll find the following artifacts in the run’s Sum
126126
[PEP 621](https://peps.python.org/pep-0621/) calls it `readme`, in classic *setuptools* it’s `long_description`.
127127

128128

129+
### Job Summaries
130+
131+
To save you from downloading the artifacts just to check their contents, *build-and-inspect-python-package* creates the following job summaries:
132+
133+
- **SDist contents**: A tree of the source distribution.
134+
- **Wheel contents**: A tree of the built wheel – if one was built.
135+
- **Metadata**: A dump of package metadata (includes the PyPI README).
136+
137+
129138
### Examples
130139

131140
[Our CI](.github/workflows/ci.yml) uses all inputs and outputs, if you want to see them in action.

0 commit comments

Comments
 (0)