📝 Document destination output (#2)

This commit is contained in:
Samuel Ryan 2020-08-29 18:07:22 +01:00 committed by GitHub
parent bf80417647
commit f393b455c4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 2 deletions

View file

@ -18,6 +18,12 @@ All inputs are required.
| `image` | Docker Image to extract files from | `alpine` |
| `path` | Path (from root) to a file or directory within Image | `/etc/motd` |
## Outputs
| ID | Description | Example |
| --- | ----------- | ------- |
| `destination` | Destination path containing the extracted file(s) | `.extracted-1598717412` |
## Examples
### Build, Extract
@ -64,7 +70,7 @@ jobs:
with:
registry: docker.pkg.github.com
username: ${{ github.repository_owner }}
password: ${{ secrets.GITHUB_TOKEN }}
password: ${{ github.token }}
- uses: shrink/actions-docker-extract@v1
with:
image: ${{ github.repository }}/example-image:latest

View file

@ -1,6 +1,6 @@
{
"name": "@shrink/actions-docker-extract",
"version": "0.1.0",
"version": "1.0.1",
"description": "Extract from a Docker Image",
"author": "Samuel Ryan <sam@samryan.co.uk>",
"homepage": "https://github.com/shrink/actions-docker-extract#readme",