Update the readme

This commit is contained in:
Chl 2024-08-29 04:01:56 +02:00
parent 705e2d717c
commit 9588309c74
Signed by: chl
GPG key ID: 80012B734F21B934
2 changed files with 16 additions and 5 deletions

View file

@ -37,7 +37,7 @@ jobs:
- name: Check the content of the uploaded artifact
run: |
# Stop at first error and be verbose
# Stop at first error and be verbose
set -ex
# Create some temporary files/directory

View file

@ -9,21 +9,23 @@ the artifact uploading required a full blown NodeJS container.
## Usage
This actions won't copy all the features of the original NodeJS version but
This action won't copy all the features of the original NodeJS version but
please report differences on the main ones.
### Requirements
This action needs the following executables:
* zip (unless you zip the artifact yourself)
* wget (the full version : unfortunately, as of 2024-08-26, the busybox variant isn't capable of using the PUT method)
* `zip` (unless you zip the artifact yourself)
* `wget` (the full version : unfortunately, as of 2024-08-26, the busybox variant isn't capable of using the PUT method)
### Inputs
```yaml
- uses: actions/upload-artifact@v4
# If you can, give the full URL :
# - uses: https://entrepot.xlii.si/actions/upload-artifact-with-wget@v4
- uses: actions/upload-artifact-with-wget@v4
with:
# Name of the artifact to upload.
# Optional. Default is 'artifact'
@ -32,6 +34,14 @@ This action needs the following executables:
# A file, directory or wildcard pattern that describes what to upload
# Required.
path:
# If the artifact is already a zipfile, set to false.
# Optional. Default is true.
compression:
# Set the compression level of the zipfile.
# Optional. Default is '6'.
compression-level:
```
### Outputs
@ -39,6 +49,7 @@ This action needs the following executables:
| Name | Description | Example |
| - | - | - |
| `artifact-id` | GitHub ID of an Artifact, can be used by the REST API | `1234` |
| `artifact-url` | URL to download an Artifact. | `https://github.com/example-org/example-repo/actions/runs/1/artifacts/1234` or `https://codeberg.org/forgejo/forgejo/actions/runs/1/artifacts/my-artifact` |
## Examples