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.

Sign up for GitHub

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

Documentation improvements #636

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Documentation improvements #636

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
38ea23d
Improve `if-no-files-found` documentation
jsoref Oct 30, 2024
fd99883
Improve `retention-days` documentation
jsoref Oct 30, 2024
3ebf8b2
Improve `compression-level` documentation
jsoref Oct 30, 2024
ecc6a0a
Fix `include-hidden-files` documentation grammar
jsoref Oct 30, 2024
55f5a1a
Improve outputs documentation
jsoref Oct 30, 2024
f8fff0c
Improve Zip archives documentation grammar
jsoref Oct 30, 2024
6201cb9
Improve trashcan documentation
jsoref Oct 30, 2024
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
24 changes: 13 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,21 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# Available Options:
# warn: Output a warning but do not fail the action
# error: Fail the action with an error message
# ignore: Do not output any warnings or errors, the action does not fail
# ignore: Do not output any warnings or errors, does not fail the action
# Optional. Default is 'warn'
if-no-files-found:

# Duration after which artifact will expire in days. 0 means using default retention.
# Minimum 1 day.
# Maximum 90 days unless changed from the repository settings page.
# Duration after which artifact will expire in days.
# 0 means use default retention.
# 1 is the shortest retention.
# Maximum is based on repository settings (the default is 90 days).
# Optional. Defaults to repository settings.
retention-days:

# The level of compression for Zlib to be applied to the artifact archive.
# The value can range from 0 to 9.
# For large files that are not easily compressed, a value of 0 is recommended for significantly faster uploads.
# For large files that are not easily compressed, a value of 0 is recommended for
# significantly faster uploads.
# Optional. Default is '6'
compression-level:

Expand All @@ -109,9 +111,9 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# Optional. Default is 'false'
overwrite:

# Whether to include hidden files in the provided path in the artifact
# Whether to include hidden files in the provided path in the artifact.
# The file contents of any hidden files in the path should be validated before
# enabled this to avoid uploading sensitive information.
# enabling this to avoid uploading sensitive information.
# Optional. Default is 'false'
include-hidden-files:
```
Expand All @@ -120,8 +122,8 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).

| 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. Can be used in many scenarios such as linking to artifacts in issues or pull requests. Users must be logged-in in order for this URL to work. This URL is valid as long as the artifact has not expired or the artifact, run or repository have not been deleted | `https://github.com/example-org/example-repo/actions/runs/1/artifacts/1234` |
| `artifact-id` | GitHub ID of the Artifact, can be used by the REST API | `1234` |
| `artifact-url` | URL to download the Artifact. Can be used in many scenarios such as linking to artifacts in issues or pull requests. Users must be logged-in in order for this URL to work. This URL is valid as long as the artifact has not expired and the artifact, run, and repository have not been deleted. | `https://github.com/example-org/example-repo/actions/runs/1/artifacts/1234` |

## Examples

Expand Down Expand Up @@ -449,7 +451,7 @@ You may also be limited by Artifacts if you have exceeded your shared storage qu

### Zip archives

When an Artifact is uploaded, all the files are assembled into an immutable Zip archive. There is currently no way to download artifacts in a format other than a Zip or to download individual artifact contents.
When an Artifact is uploaded, all the files are assembled into an immutable Zip archive. There is currently no way to download artifacts in a format other than Zip or to download individual artifact contents.

### Permission Loss

Expand All @@ -474,6 +476,6 @@ At the bottom of the workflow summary page, there is a dedicated section for art

<img src="https://user-images.githubusercontent.com/16109154/103645952-223c6880-4f59-11eb-8268-8dca6937b5f9.png" width="700" height="300">

There is a trashcan icon that can be used to delete the artifact. This icon will only appear for users who have write permissions to the repository.
For users who have write permissions to the repository, there is a trashcan icon that can be used to delete the artifact.

The size of the artifact is denoted in bytes. The displayed artifact size denotes the size of the zip that `upload-artifact` creates during upload.