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

Jump to bottom

Documentation improvements #636

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

Documentation improvements #636

wants to merge 7 commits into from

Commits on Oct 30, 2024

  1. Improve if-no-files-found documentation 

    If `if-no-files-found: ignore` and `overwrite: false` and an artifact already exists, the action will fail, so clarify that `ignore` doesn't guarantee the action won't fail.
    @jsoref
    jsoref committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    38ea23d View commit details
    Browse the repository at this point in the history

  2. Improve retention-days documentation 

    Clarify that `retention-days: 0` is a valid configuration which is numerically less than 1, but that the shortest retention is `1` (it is _not_ a minimum value according to Math/Numbers/Integers, it's just the shortest retention value).
Clarify that the maximum `retention-days` value is configured per repository (which implicitly inherits from organizations...) but that the default for repositories is 90 days.
    @jsoref
    jsoref committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    fd99883 View commit details
    Browse the repository at this point in the history

  3. Improve compression-level documentation 

    Wrap text so that it isn't clipped when rendered in:
https://github.com/actions/upload-artifact?tab=readme-ov-file#inputs
    @jsoref
    jsoref committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    3ebf8b2 View commit details
    Browse the repository at this point in the history

  4. Fix include-hidden-files documentation grammar

    @jsoref
    jsoref committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    ecc6a0a View commit details
    Browse the repository at this point in the history

  5. Improve outputs documentation 

    Use `the` for `artifact-id` as it's a precise instance and not an amorphous artifact.
Fix boolean grammar for `artifact-url` -- all conditions must be true in order for the `artifact-url` to be valid.
    @jsoref
    jsoref committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    55f5a1a View commit details
    Browse the repository at this point in the history

  6. Improve Zip archives documentation grammar 

    As the format is `Zip`, it's wrong to precede it with an article `a` which would be more appropriate for an instance of the format.
    @jsoref
    jsoref committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    f8fff0c View commit details
    Browse the repository at this point in the history

  7. Improve trashcan documentation 

    Reorder paragraph to simplify messaging for only users with write permissions instead of getting people's hopes up that there might be a trash can only to dash it a sentence later.
    @jsoref
    jsoref committed Oct 30, 2024
    Configuration menu
    Copy the full SHA
    6201cb9 View commit details
    Browse the repository at this point in the history