From fd9988342329c884ea22ae2172a82d552b94fbee Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 30 Oct 2024 09:28:16 -0400 Subject: [PATCH] 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. --- README.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9e56853..48a805e 100644 --- a/README.md +++ b/README.md @@ -91,9 +91,10 @@ For assistance with breaking changes, see [MIGRATION.md](docs/MIGRATION.md). # 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: