docker/metadata-action
1
0
Fork 0
mirror of https://github.com/docker/metadata-action.git synced 2025-12-17 06:48:59 +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) - [About](#about)
* [Basic](#basic) - [Usage](#usage)
* [Semver](#semver) - [Basic](#basic)
* [Bake definition](#bake-definition) - [Semver](#semver)
* [Customizing](#customizing) - [Bake definition](#bake-definition)
* [inputs](#inputs) - [Customizing](#customizing)
* [outputs](#outputs) - [inputs](#inputs)
* [`flavor` input](#flavor-input) - [outputs](#outputs)
* [`tags` input](#tags-input) - [`flavor` input](#flavor-input)
* [`type=schedule`](#typeschedule) - [`tags` input](#tags-input)
* [`type=semver`](#typesemver) - [`type=schedule`](#typeschedule)
* [`type=match`](#typematch) - [`type=semver`](#typesemver)
* [`type=edge`](#typeedge) - [`type=match`](#typematch)
* [`type=ref`](#typeref) - [`type=edge`](#typeedge)
* [`type=raw`](#typeraw) - [`type=ref`](#typeref)
* [`type=sha`](#typesha) - [`type=raw`](#typeraw)
* [Notes](#notes) - [`type=sha`](#typesha)
* [Latest tag](#latest-tag) - [Notes](#notes)
* [Global expressions](#global-expressions) - [Latest tag](#latest-tag)
* [Major version zero](#major-version-zero) - [Global expressions](#global-expressions)
* [JSON output object](#json-output-object) - [Major version zero](#major-version-zero)
* [Overwrite labels](#overwrite-labels) - [JSON output object](#json-output-object)
* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot) - [Overwrite labels](#overwrite-labels)
- [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
## Usage ## Usage
@ -287,11 +288,13 @@ flavor: |
latest=auto latest=auto
prefix= prefix=
suffix= suffix=
on_latest=
``` ```
* `latest=<auto|true|false>`: Handle [latest tag](#latest-tag) (default `auto`) * `latest=<auto|true|false>`: Handle [latest tag](#latest-tag) (default `auto`)
* `prefix=<string>`: A global prefix for each generated tag * `prefix=<string>`: A global prefix for each generated tag
* `suffix=<string>`: A global suffix 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 ## `tags` input