Merge pull request #528 from crazy-max/update-readme

readme: show additional case for semver

.github/workflows/pr-assign-author.yml

@@ -0,0 +1,17 @@
+name: pr-assign-author
+
+permissions:
+  contents: read
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+
+jobs:
+  run:
+    uses: crazy-max/.github/.github/workflows/pr-assign-author.yml@1b673f36fad86812f538c1df9794904038a23cbf
+    permissions:
+      contents: read
+      pull-requests: write

.github/workflows/test.yml

@@ -15,14 +15,18 @@ jobs:
   test:
     runs-on: ubuntu-latest
     steps:
+      -
+        name: Checkout
+        uses: actions/checkout@v4
       -
         name: Test
         uses: docker/bake-action@v6
         with:
+          source: .
           targets: test
       -
         name: Upload coverage
         uses: codecov/codecov-action@v5
         with:
-          file: ./coverage/clover.xml
+          files: ./coverage/clover.xml
           token: ${{ secrets.CODECOV_TOKEN }}

README.md

@@ -283,6 +283,7 @@ similar to the previous one:
 
 The following inputs can be used as `step.with` keys:
 
+> [!NOTE]
 > `List` type is a newline-delimited string
 > ```yaml
 > labels: |
@@ -508,18 +509,20 @@ with the following expressions:
 * `minor` ; minor version identifier
 * `patch` ; patch version identifier
 
-| Git tag            | Pattern                                                  | Output               |
+| Git tag            | Pattern               | Output               |
-|--------------------|----------------------------------------------------------|----------------------|
+|--------------------|-----------------------|----------------------|
-| `v1.2.3`           | `{{raw}}`                                                | `v1.2.3`             |
+| `v1.2.3`           | `{{raw}}`             | `v1.2.3`             |
-| `v1.2.3`           | `{{version}}`                                            | `1.2.3`              |
+| `v1.2.3`           | `{{version}}`         | `1.2.3`              |
-| `v1.2.3`           | `{{major}}.{{minor}}`                                    | `1.2`                |
+| `v1.2.3`           | `{{major}}.{{minor}}` | `1.2`                |
-| `v1.2.3`           | `v{{major}}`                                             | `v1`                 |
+| `v1.2.3`           | `v{{major}}`          | `v1`                 |
-| `v1.2.3`           | `{{minor}}`                                              | `2`                  |
+| `v1.2.3`           | `{{minor}}`           | `2`                  |
-| `v1.2.3`           | `{{patch}}`                                              | `3`                  |
+| `v1.2.3`           | `{{patch}}`           | `3`                  |
-| `v2.0.8-beta.67`   | `{{raw}}`                                                | `v2.0.8-beta.67`     |
+| `v2.0.8-beta.67`   | `{{raw}}`             | `v2.0.8-beta.67`     |
-| `v2.0.8-beta.67`   | `{{version}}`                                            | `2.0.8-beta.67`      |
+| `v2.0.8-beta.67`   | `{{version}}`         | `2.0.8-beta.67`      |
-| `v2.0.8-beta.67`   | `{{major}}.{{minor}}`                                    | `2.0.8-beta.67`*     |
+| `v2.0.8-beta.67`   | `{{major}}`           | `2.0.8-beta.67`*     |
+| `v2.0.8-beta.67`   | `{{major}}.{{minor}}` | `2.0.8-beta.67`*     |
 
+> [!IMPORTANT]
 > *Pre-release (rc, beta, alpha) will only extend `{{version}}` (or `{{raw}}`
 > if specified) as tag because they are updated frequently, and contain many
 > breaking changes that are (by the author's design) not yet fit for public
@@ -569,6 +572,7 @@ with the following expressions:
 | `1.2.3beta2`       | `{{major}}.{{minor}}`                                    | `1.2.3b2`*           |
 | `1.0dev4`          | `{{major}}.{{minor}}`                                    | `1.0.dev4`*          |
 
+> [!IMPORTANT]
 > *dev/pre/post release will only extend `{{version}}` (or `{{raw}}` if
 > specified) as tag because they are updated frequently, and contain many
 > 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:
 | `push`         | `refs/heads/my/branch`        |                    |
 | `push tag`*    | `refs/tags/v1.2.3`            | `master`           |
 
+> [!IMPORTANT]
 > *`base_ref` is available in the push payload but doesn't always seem to 
 > return the expected branch when the push tag event occurs. It's also
 > [not documented in GitHub docs](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push).

package.json

@@ -28,19 +28,19 @@
   "packageManager": "yarn@3.6.3",
   "dependencies": {
     "@actions/core": "^1.11.1",
-    "@actions/github": "^6.0.0",
+    "@actions/github": "^6.0.1",
-    "@docker/actions-toolkit": "^0.56.0",
+    "@docker/actions-toolkit": "^0.62.1",
     "@renovate/pep440": "^1.0.0",
     "csv-parse": "^5.6.0",
     "handlebars": "^4.7.8",
     "moment": "^2.30.1",
-    "moment-timezone": "^0.5.47",
+    "moment-timezone": "^0.6.0",
-    "semver": "^7.7.1"
+    "semver": "^7.7.2"
   },
   "devDependencies": {
     "@types/csv-parse": "^1.2.2",
     "@types/node": "^20.12.12",
-    "@types/semver": "^7.5.8",
+    "@types/semver": "^7.7.0",
     "@typescript-eslint/eslint-plugin": "^7.9.0",
     "@typescript-eslint/parser": "^7.9.0",
     "@vercel/ncc": "^0.38.1",

yarn.lock

@@ -12,9 +12,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@actions/artifact@npm:^2.2.2":
+"@actions/artifact@npm:^2.3.2":
-  version: 2.2.2
+  version: 2.3.2
-  resolution: "@actions/artifact@npm:2.2.2"
+  resolution: "@actions/artifact@npm:2.3.2"
   dependencies:
     "@actions/core": ^1.10.0
     "@actions/github": ^5.1.1
@@ -28,13 +28,13 @@ __metadata:
     archiver: ^7.0.1
     jwt-decode: ^3.1.2
     unzip-stream: ^0.3.1
-  checksum: 1501b3d0ceb671f370786ccf70014de9586c5a78c95d235248fc16c73bf928f8de2aa932a679258f6d9bc2f2e570648d830551af9f063298f05d19f3330b33bc
+  checksum: 78ee41b43800accb2f3527e1733217c43d53693e7f96ce2470b16890fb84f5c2ebaaa6048ccdb6cfe188b54c02779ec99623c6932558e757f6829cfde203cf2c
   languageName: node
   linkType: hard
 
-"@actions/cache@npm:^4.0.2":
+"@actions/cache@npm:^4.0.3":
-  version: 4.0.2
+  version: 4.0.3
-  resolution: "@actions/cache@npm:4.0.2"
+  resolution: "@actions/cache@npm:4.0.3"
   dependencies:
     "@actions/core": ^1.11.1
     "@actions/exec": ^1.0.1
@@ -46,7 +46,7 @@ __metadata:
     "@azure/storage-blob": ^12.13.0
     "@protobuf-ts/plugin": ^2.9.4
     semver: ^6.3.1
-  checksum: 208f11238a26194f331b329bb99d50a87c1a3ccef1dbae181e5c142b3faf41715203e0c5cbc491519d3d97540a68fbd418c25fb6e16caabf76248c40867c02b4
+  checksum: ee9c2a21a70bd3f35c63f302af478e23f135c26deb77ea2e4eed29c62766a4b201fc7435651c0d56fa504c02d203107e3bdfda1dba18a3ee09338e1dfc3f2fe8
   languageName: node
   linkType: hard
 
@@ -91,15 +91,18 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@actions/github@npm:^6.0.0":
+"@actions/github@npm:^6.0.1":
-  version: 6.0.0
+  version: 6.0.1
-  resolution: "@actions/github@npm:6.0.0"
+  resolution: "@actions/github@npm:6.0.1"
   dependencies:
     "@actions/http-client": ^2.2.0
     "@octokit/core": ^5.0.1
-    "@octokit/plugin-paginate-rest": ^9.0.0
+    "@octokit/plugin-paginate-rest": ^9.2.2
-    "@octokit/plugin-rest-endpoint-methods": ^10.0.0
+    "@octokit/plugin-rest-endpoint-methods": ^10.4.0
-  checksum: 81831a78377175d8825fc0b94247ff366c0e87ad1dfa48df9b30b8659506f216dcf1e2d3124fcd318839b92c24ba20165e238b3cc11a34db89c69c40825e9ccf
+    "@octokit/request": ^8.4.1
+    "@octokit/request-error": ^5.1.1
+    undici: ^5.28.5
+  checksum: ba6a162a5727dea2f3f3fc450e02c5b336ceb65a0e26ba9ad9c62b20f4f5b2625ca347a9311a4905ef3c92378ca022caba841a283cb7f2e4175d79e3d1ecaf12
   languageName: node
   linkType: hard
 
@@ -1098,15 +1101,15 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@docker/actions-toolkit@npm:^0.56.0":
+"@docker/actions-toolkit@npm:^0.62.1":
-  version: 0.56.0
+  version: 0.62.1
-  resolution: "@docker/actions-toolkit@npm:0.56.0"
+  resolution: "@docker/actions-toolkit@npm:0.62.1"
   dependencies:
-    "@actions/artifact": ^2.2.2
+    "@actions/artifact": ^2.3.2
-    "@actions/cache": ^4.0.2
+    "@actions/cache": ^4.0.3
     "@actions/core": ^1.11.1
     "@actions/exec": ^1.1.1
-    "@actions/github": ^6.0.0
+    "@actions/github": ^6.0.1
     "@actions/http-client": ^2.2.3
     "@actions/io": ^1.1.3
     "@actions/tool-cache": ^2.0.2
@@ -1120,10 +1123,10 @@ __metadata:
     he: ^1.2.0
     js-yaml: ^4.1.0
     jwt-decode: ^4.0.0
-    semver: ^7.7.1
+    semver: ^7.7.2
     tar-stream: ^3.1.7
     tmp: ^0.2.3
-  checksum: 0f1b569f8bb206399f8c26e566c78e30e4a311bbd64486016e7fa1d35fbbb4c94d4f55afa6b711afa4b41c5835b40b038f48c3d1bfdfdc6f7c6680973e922d9e
+  checksum: 72dfef5073c7b638a73b53ccd48ec9dc3fa0e0c1b1b0aaf711fc872ef4ef0a882909271c01913f335efc5f868e4062e6e7720b92d6c3a605ecb6cc30d3001f9d
   languageName: node
   linkType: hard
 
@@ -1712,6 +1715,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@octokit/endpoint@npm:^9.0.6":
+  version: 9.0.6
+  resolution: "@octokit/endpoint@npm:9.0.6"
+  dependencies:
+    "@octokit/types": ^13.1.0
+    universal-user-agent: ^6.0.0
+  checksum: f853c08f0777a8cc7c3d2509835d478e11a76d722f807d4f2ad7c0e64bf4dd159536409f466b367a907886aa3b78574d3d09ed95ac462c769e4fccaaad81e72a
+  languageName: node
+  linkType: hard
+
 "@octokit/graphql@npm:^4.5.8":
   version: 4.8.0
   resolution: "@octokit/graphql@npm:4.8.0"
@@ -1755,6 +1768,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@octokit/openapi-types@npm:^24.2.0":
+  version: 24.2.0
+  resolution: "@octokit/openapi-types@npm:24.2.0"
+  checksum: 3c2d2f4cafd21c8a1e6a6fe6b56df6a3c09bc52ab6f829c151f9397694d028aa183ae856f08e006ee7ecaa7bd7eb413a903fbc0ffa6403e7b284ddcda20b1294
+  languageName: node
+  linkType: hard
+
 "@octokit/plugin-paginate-rest@npm:^2.17.0":
   version: 2.21.3
   resolution: "@octokit/plugin-paginate-rest@npm:2.21.3"
@@ -1766,14 +1786,14 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@octokit/plugin-paginate-rest@npm:^9.0.0":
+"@octokit/plugin-paginate-rest@npm:^9.2.2":
-  version: 9.0.0
+  version: 9.2.2
-  resolution: "@octokit/plugin-paginate-rest@npm:9.0.0"
+  resolution: "@octokit/plugin-paginate-rest@npm:9.2.2"
   dependencies:
-    "@octokit/types": ^12.0.0
+    "@octokit/types": ^12.6.0
   peerDependencies:
-    "@octokit/core": ">=5"
+    "@octokit/core": 5
-  checksum: 4a8543f3e45c4916f94edc57d66106ee60da9fd4edccd7c3a2ddd00da1fc4eb2e1b2bcb3d6cb981a050edf883100c5004d0b81497568d4ac9138310a2188a458
+  checksum: ea2a3ebf6abc128a1996c5ff7148ebe755ee2ed001aa0c1d3088d67a9d78b093d84820e3ec73bfb165ca8774943a1158afdae4cf7b90b0a07f12ebbe1d8a428b
   languageName: node
   linkType: hard
 
@@ -1786,7 +1806,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@octokit/plugin-rest-endpoint-methods@npm:^10.0.0, @octokit/plugin-rest-endpoint-methods@npm:^10.4.0":
+"@octokit/plugin-rest-endpoint-methods@npm:^10.4.0":
   version: 10.4.0
   resolution: "@octokit/plugin-rest-endpoint-methods@npm:10.4.0"
   dependencies:
@@ -1841,6 +1861,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@octokit/request-error@npm:^5.1.1":
+  version: 5.1.1
+  resolution: "@octokit/request-error@npm:5.1.1"
+  dependencies:
+    "@octokit/types": ^13.1.0
+    deprecation: ^2.0.0
+    once: ^1.4.0
+  checksum: 17d0b3f59c2a8a285715bfe6a85168d9c417aa7a0ff553b9be4198a3bc8bb00384a3530221a448eb19f8f07ea9fc48d264869624f5f84fa63a948a7af8cddc8c
+  languageName: node
+  linkType: hard
+
 "@octokit/request@npm:^5.6.0, @octokit/request@npm:^5.6.3":
   version: 5.6.3
   resolution: "@octokit/request@npm:5.6.3"
@@ -1868,6 +1899,18 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@octokit/request@npm:^8.4.1":
+  version: 8.4.1
+  resolution: "@octokit/request@npm:8.4.1"
+  dependencies:
+    "@octokit/endpoint": ^9.0.6
+    "@octokit/request-error": ^5.1.1
+    "@octokit/types": ^13.1.0
+    universal-user-agent: ^6.0.0
+  checksum: 0ba76728583543baeef9fda98690bc86c57e0a3ccac8c189d2b7d144d248c89167eb37a071ed8fead8f4da0a1c55c4dd98a8fc598769c263b95179fb200959de
+  languageName: node
+  linkType: hard
+
 "@octokit/types@npm:^12.0.0":
   version: 12.0.0
   resolution: "@octokit/types@npm:12.0.0"
@@ -1886,6 +1929,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@octokit/types@npm:^13.1.0":
+  version: 13.10.0
+  resolution: "@octokit/types@npm:13.10.0"
+  dependencies:
+    "@octokit/openapi-types": ^24.2.0
+  checksum: fca3764548d5872535b9025c3b5fe6373fe588b287cb5b5259364796c1931bbe5e9ab8a86a5274ce43bb2b3e43b730067c3b86b6b1ade12a98cd59b2e8b3610d
+  languageName: node
+  linkType: hard
+
 "@octokit/types@npm:^6.0.3, @octokit/types@npm:^6.16.1, @octokit/types@npm:^6.39.0, @octokit/types@npm:^6.40.0":
   version: 6.41.0
   resolution: "@octokit/types@npm:6.41.0"
@@ -2146,10 +2198,10 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@types/semver@npm:^7.5.8":
+"@types/semver@npm:^7.7.0":
-  version: 7.5.8
+  version: 7.7.0
-  resolution: "@types/semver@npm:7.5.8"
+  resolution: "@types/semver@npm:7.7.0"
-  checksum: ea6f5276f5b84c55921785a3a27a3cd37afee0111dfe2bcb3e03c31819c197c782598f17f0b150a69d453c9584cd14c4c4d7b9a55d2c5e6cacd4d66fdb3b3663
+  checksum: d488eaeddb23879a0a8a759bed667e1a76cb0dd4d23e3255538e24c189db387357953ca9e7a3bda2bb7f95e84cac8fe0db4fbe6b3456e893043337732d1d23cc
   languageName: node
   linkType: hard
 
@@ -3196,12 +3248,12 @@ __metadata:
   resolution: "docker-metadata-action@workspace:."
   dependencies:
     "@actions/core": ^1.11.1
-    "@actions/github": ^6.0.0
+    "@actions/github": ^6.0.1
-    "@docker/actions-toolkit": ^0.56.0
+    "@docker/actions-toolkit": ^0.62.1
     "@renovate/pep440": ^1.0.0
     "@types/csv-parse": ^1.2.2
     "@types/node": ^20.12.12
-    "@types/semver": ^7.5.8
+    "@types/semver": ^7.7.0
     "@typescript-eslint/eslint-plugin": ^7.9.0
     "@typescript-eslint/parser": ^7.9.0
     "@vercel/ncc": ^0.38.1
@@ -3214,9 +3266,9 @@ __metadata:
     handlebars: ^4.7.8
     jest: ^29.7.0
     moment: ^2.30.1
-    moment-timezone: ^0.5.47
+    moment-timezone: ^0.6.0
     prettier: ^3.2.5
-    semver: ^7.7.1
+    semver: ^7.7.2
     ts-jest: ^29.1.2
     ts-node: ^10.9.2
     typescript: ^5.4.5
@@ -5249,12 +5301,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"moment-timezone@npm:^0.5.47":
+"moment-timezone@npm:^0.6.0":
-  version: 0.5.47
+  version: 0.6.0
-  resolution: "moment-timezone@npm:0.5.47"
+  resolution: "moment-timezone@npm:0.6.0"
   dependencies:
     moment: ^2.29.4
-  checksum: 6288a9d653b902bd913f1dca24426ad71e5a98cd98684139e3ed74e635289e6acde62450735364fd3758d6ac836a1eaab859c08d0252587a377192f25f0bda5a
+  checksum: 87cf0ecb17b36251bce3ec95edbc8eed5244d4e4b03f545ef2502a5607fde0f6ea767b7d7ef49eca90c68c326748d820c1d73cf7fea2d0b3b7ea738614e05edc
   languageName: node
   linkType: hard
 
@@ -5928,12 +5980,12 @@ __metadata:
   languageName: node
   linkType: hard
 
-"semver@npm:^7.7.1":
+"semver@npm:^7.7.2":
-  version: 7.7.1
+  version: 7.7.2
-  resolution: "semver@npm:7.7.1"
+  resolution: "semver@npm:7.7.2"
   bin:
     semver: bin/semver.js
-  checksum: 586b825d36874007c9382d9e1ad8f93888d8670040add24a28e06a910aeebd673a2eb9e3bf169c6679d9245e66efb9057e0852e70d9daa6c27372aab1dda7104
+  checksum: dd94ba8f1cbc903d8eeb4dd8bf19f46b3deb14262b6717d0de3c804b594058ae785ef2e4b46c5c3b58733c99c83339068203002f9e37cfe44f7e2cc5e3d2f621
   languageName: node
   linkType: hard
 
@@ -6532,6 +6584,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"undici@npm:^5.28.5":
+  version: 5.29.0
+  resolution: "undici@npm:5.29.0"
+  dependencies:
+    "@fastify/busboy": ^2.0.0
+  checksum: a25b5462c1b6ffb974f5ffc492ffd64146a9983aad0cbda6fde65e2b22f6f1acd43f09beacc66cc47624a113bd0c684ffc60366102b6a21b038fbfafb7d75195
+  languageName: node
+  linkType: hard
+
 "unique-filename@npm:^3.0.0":
   version: 3.0.0
   resolution: "unique-filename@npm:3.0.0"