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.
pull/636/head
Josh Soref 2024-10-30 09:28:16 -04:00
parent 38ea23d5ce
commit fd99883423
1 changed files with 4 additions and 3 deletions

View File

@ -91,9 +91,10 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md).
# Optional. Default is 'warn' # Optional. Default is 'warn'
if-no-files-found: if-no-files-found:
# Duration after which artifact will expire in days. 0 means using default retention. # Duration after which artifact will expire in days.
# Minimum 1 day. # 0 means use default retention.
# Maximum 90 days unless changed from the repository settings page. # 1 is the shortest retention.
# Maximum is based on repository settings (the default is 90 days).
# Optional. Defaults to repository settings. # Optional. Defaults to repository settings.
retention-days: retention-days: