From b4dbe55c266a6a04c3ca650d42f1d2188691f164 Mon Sep 17 00:00:00 2001 From: eine Date: Sat, 6 Jun 2020 21:44:33 +0200 Subject: [PATCH] update README.md --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1fc2fec..6418962 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -**tip** is a Docker GitHub Action written in Python. **tip** allows to keep a pre-release and its artifacts up to date with a latest builds. Combined with a workflow that is executed periodically, **tip** allows to provide a fixed release name for users willing to use daily/nightly artifacts of a project. +**tip** is a Docker GitHub Action written in Python. **tip** allows to keep a pre-release and its artifacts up to date with latest builds. Combined with a workflow that is executed periodically, **tip** allows to provide a fixed release name for users willing to use daily/nightly artifacts of a project. + +# Usage The following block shows a minimal YAML workflow file: @@ -35,6 +37,22 @@ jobs: Note that the tag and the pre-release need to be created manually the first time. The workflow above will fail if the release does not exist. -The default tag name is `tip`, but it can be optionally overriden through option `tag` or setting envvar `INPUT_TAG`. +# Options -If you systematically want to remove previous artifacts (e.g. old versions), set the `rm` option to true. +All options can be optionally provided as environment variables: `INPUT_TOKEN`, `INPUT_FILES`, `INPUT_TAG` and/or `INPUT_RM`. + +## token (required) + +Token to make authenticated API calls; can be passed in using `{{ secrets.GITHUB_TOKEN }}`. + +## files (required) + +Either a single filename/pattern or a multi-line list can be provided. All the artifacts are uploaded regardless of the hierarchy. + +## tag + +The default tag name for the tip/nightly pre-release is `tip`, but it can be optionally overriden through option `tag`. + +## rm + +Set option `rm` to `true` for systematically removing previous artifacts (e.g. old versions). Otherwise (by default), all previours artifacts are preserved or overwritten.