Skip to content
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.

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

Add dist output #9

Merged
merged 3 commits into from
Aug 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 3 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,5 +27,8 @@ jobs:
path: action

- uses: ./action
id: baipp
with:
path: structlog

- run: echo Packages can be found at ${{ steps.baipp.outputs.dist }}
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased](/~https://github.com/hynek/build-and-inspect-python-package/compare/v1.1...main)

### Added

- The location of the built packages is now returned using the `dist` output.

## [1.1](/~https://github.com/hynek/build-and-inspect-python-package/compare/v1.0...v1.1)

Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ This action provides the following functionality for GitHub Actions users that a
This way you can make package verification part of your CI.
If you package an **application** as a Python package, this action is useful to double-check you're shipping everything you need, including all templates, translation files, et cetera.

If you want to perform more checks againt the built packages in the CI, you can find them in `/tmp/baipp-out/`.

> **Note**
> This action does **not** upload your package to PyPI.

Expand All @@ -37,6 +35,10 @@ The action will run [*setup-python*](/~https://github.com/actions/setup-python) wi

- `path`: the location of the Python package to build (default: `.`).

### Outputs

- `dist`: the location with the built packages.


## License

Expand Down
9 changes: 9 additions & 0 deletions action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ inputs:
description: Where to look for the Python package to inspect.
required: false
default: .
outputs:
dist:
description: The location of the built packages.
value: ${{ steps.setter.outputs.dist }}

runs:
using: composite
Expand All @@ -31,6 +35,11 @@ runs:
shell: bash
working-directory: ${{ inputs.path }}

- name: Set output
id: setter
shell: bash
run: echo "::set-output name=dist::/tmp/baipp-out/"

# Give user overview over what we've built.
- run: ls -l /tmp/baipp-out
shell: bash
Expand Down