docker/metadata-action
3
0
Fork 0
mirror of https://github.com/docker/metadata-action.git synced 2025-06-24 03:37:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

Allow to templatize schedule tag (#1)

Browse Source 
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax
2020-10-25 15:13:43 +01:00
committed by GitHub
parent 88d487154b
commit 3b38d53d94
10 changed files with 14262 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -21,6 +21,8 @@ ___
* [Customizing](#customizing)
* [inputs](#inputs)
* [outputs](#outputs)
* [Notes](#notes)
* [Templates available for schedule tag](#templates-available-for-schedule-tag)
* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
* [How can I help?](#how-can-i-help)
* [License](#license)
@ -34,13 +36,13 @@ ___
| Event | Ref | Commit SHA | Docker Tag | Pushed |
|-----------------|-------------------------------|------------|------------------------------------|--------|
| `schedule` | | | `nightly` | Yes |
| `schedule` | | `45f132a` | `sha-45f132a`, `nightly` | Yes |
| `pull_request` | `refs/pull/2/merge` | `a123b57` | `sha-a123b57`, `pr-2` | No |
| `push` | `refs/heads/<default_branch>` | `676cae2` | `sha-676cae2`, `edge` | Yes |
| `push` | `refs/heads/dev` | `cf20257` | `sha-cf20257`, `dev` | Yes |
| `push` | `refs/heads/my/branch` | `a5df687` | `sha-a5df687`, `my-branch` | Yes |
| `push tag` | `refs/tags/v1.2.3` | | `1.2.3`, `latest` | Yes |
| `push tag` | `refs/tags/mytag` | | `mytag` | Yes |
| `push tag` | `refs/tags/v1.2.3` | `bf4565b` | `sha-bf4565b`, `1.2.3`, `latest` | Yes |
| `push tag` | `refs/tags/mytag` | `afb7833` | `sha-afb7833`, `mytag` | Yes |
```yaml
name: ci
@ -107,6 +109,7 @@ Following inputs can be used as `step.with` keys
| `images` | List/CSV | List of Docker images to use as base name for tags |
| `tag-sha` | Bool | Add git short SHA as Docker tag (default `false`) |
| `tag-edge` | String | Branch that will be tagged as edge (default `repo.default_branch`) |
| `tag-schedule` | String | [Handlebars template](https://handlebarsjs.com/guide/) to apply to schedule tag (default `nightly`) |
| `sep-tags` | String | Separator to use for tags output (default `\n`) |
| `sep-labels` | String | Separator to use for labels output (default `\n`) |
@ -122,6 +125,19 @@ Following outputs are available
| `tags` | String | Generated Docker tags |
| `labels` | String | Generated Docker labels |
## Notes
### Templates available for schedule tag
`tag-schedule` is specially crafted input to support [Handlebars template](https://handlebarsjs.com/guide/) with
the following expressions:
| Expression | Example | Description |
|-------------------------|-------------------------------------------|------------------------------------------|
| `{{date 'format'}}` | `{{date 'YYYYMMDD'}}` > `20200110` | Render date by its [moment format](https://momentjs.com/docs/#/displaying/format/)
You can find more examples in the [CI workflow](.github/workflows/ci.yml).
## Keep up-to-date with GitHub Dependabot
Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)