Skip to content

Commit be19121

Browse files
authored
Merge pull request docker#528 from crazy-max/update-readme
readme: show additional case for semver
2 parents b798ed8 + c1eb031 commit be19121

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,7 @@ similar to the previous one:
283283

284284
The following inputs can be used as `step.with` keys:
285285

286+
> [!NOTE]
286287
> `List` type is a newline-delimited string
287288
> ```yaml
288289
> labels: |
@@ -508,18 +509,20 @@ with the following expressions:
508509
* `minor` ; minor version identifier
509510
* `patch` ; patch version identifier
510511

511-
| Git tag | Pattern | Output |
512-
|--------------------|----------------------------------------------------------|----------------------|
513-
| `v1.2.3` | `{{raw}}` | `v1.2.3` |
514-
| `v1.2.3` | `{{version}}` | `1.2.3` |
515-
| `v1.2.3` | `{{major}}.{{minor}}` | `1.2` |
516-
| `v1.2.3` | `v{{major}}` | `v1` |
517-
| `v1.2.3` | `{{minor}}` | `2` |
518-
| `v1.2.3` | `{{patch}}` | `3` |
519-
| `v2.0.8-beta.67` | `{{raw}}` | `v2.0.8-beta.67` |
520-
| `v2.0.8-beta.67` | `{{version}}` | `2.0.8-beta.67` |
521-
| `v2.0.8-beta.67` | `{{major}}.{{minor}}` | `2.0.8-beta.67`* |
522-
512+
| Git tag | Pattern | Output |
513+
|--------------------|-----------------------|----------------------|
514+
| `v1.2.3` | `{{raw}}` | `v1.2.3` |
515+
| `v1.2.3` | `{{version}}` | `1.2.3` |
516+
| `v1.2.3` | `{{major}}.{{minor}}` | `1.2` |
517+
| `v1.2.3` | `v{{major}}` | `v1` |
518+
| `v1.2.3` | `{{minor}}` | `2` |
519+
| `v1.2.3` | `{{patch}}` | `3` |
520+
| `v2.0.8-beta.67` | `{{raw}}` | `v2.0.8-beta.67` |
521+
| `v2.0.8-beta.67` | `{{version}}` | `2.0.8-beta.67` |
522+
| `v2.0.8-beta.67` | `{{major}}` | `2.0.8-beta.67`* |
523+
| `v2.0.8-beta.67` | `{{major}}.{{minor}}` | `2.0.8-beta.67`* |
524+
525+
> [!IMPORTANT]
523526
> *Pre-release (rc, beta, alpha) will only extend `{{version}}` (or `{{raw}}`
524527
> if specified) as tag because they are updated frequently, and contain many
525528
> breaking changes that are (by the author's design) not yet fit for public
@@ -569,6 +572,7 @@ with the following expressions:
569572
| `1.2.3beta2` | `{{major}}.{{minor}}` | `1.2.3b2`* |
570573
| `1.0dev4` | `{{major}}.{{minor}}` | `1.0.dev4`* |
571574

575+
> [!IMPORTANT]
572576
> *dev/pre/post release will only extend `{{version}}` (or `{{raw}}` if
573577
> specified) as tag because they are updated frequently, and contain many
574578
> breaking changes that are (by the author's design) not yet fit for public
@@ -858,6 +862,7 @@ workflow run. Will be empty for a branch reference:
858862
| `push` | `refs/heads/my/branch` | |
859863
| `push tag`* | `refs/tags/v1.2.3` | `master` |
860864

865+
> [!IMPORTANT]
861866
> *`base_ref` is available in the push payload but doesn't always seem to
862867
> return the expected branch when the push tag event occurs. It's also
863868
> [not documented in GitHub docs](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push).

0 commit comments

Comments
 (0)