docker/metadata-action
1
0
Fork 0
mirror of https://github.com/docker/metadata-action.git synced 2025-12-16 14:29:00 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added documentation to README

Browse Source
This commit is contained in:
Jacob White 2021-06-16 13:18:42 -04:00
parent cffbfa0b4d
commit eddf5848c2
No known key found for this signature in database
GPG Key ID: 2E58765CE9B2BB40
1 changed files with 26 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@ -12,29 +12,30 @@ GitHub Action to extract metadata (tags, labels) for Docker. This action is part
___
* [Usage](#usage)
* [Basic](#basic)
* [Semver](#semver)
* [Bake definition](#bake-definition)
* [Customizing](#customizing)
* [inputs](#inputs)
* [outputs](#outputs)
* [`flavor` input](#flavor-input)
* [`tags` input](#tags-input)
* [`type=schedule`](#typeschedule)
* [`type=semver`](#typesemver)
* [`type=match`](#typematch)
* [`type=edge`](#typeedge)
* [`type=ref`](#typeref)
* [`type=raw`](#typeraw)
* [`type=sha`](#typesha)
* [Notes](#notes)
* [Latest tag](#latest-tag)
* [Global expressions](#global-expressions)
* [Major version zero](#major-version-zero)
* [JSON output object](#json-output-object)
* [Overwrite labels](#overwrite-labels)
* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
- [About](#about)
- [Usage](#usage)
- [Basic](#basic)
- [Semver](#semver)
- [Bake definition](#bake-definition)
- [Customizing](#customizing)
- [inputs](#inputs)
- [outputs](#outputs)
- [`flavor` input](#flavor-input)
- [`tags` input](#tags-input)
- [`type=schedule`](#typeschedule)
- [`type=semver`](#typesemver)
- [`type=match`](#typematch)
- [`type=edge`](#typeedge)
- [`type=ref`](#typeref)
- [`type=raw`](#typeraw)
- [`type=sha`](#typesha)
- [Notes](#notes)
- [Latest tag](#latest-tag)
- [Global expressions](#global-expressions)
- [Major version zero](#major-version-zero)
- [JSON output object](#json-output-object)
- [Overwrite labels](#overwrite-labels)
- [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
## Usage
@ -287,11 +288,13 @@ flavor: |
latest=auto
prefix=
suffix=
on_latest=
```
* `latest=<auto|true|false>`: Handle [latest tag](#latest-tag) (default `auto`)
* `prefix=<string>`: A global prefix for each generated tag
* `suffix=<string>`: A global suffix for each generated tag
* `on_latest=<true|false>`: Apply prefix and suffix to [latest tag](#latest-tag) (default `false`)
## `tags` input