PEP 440 support

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
docker · Jul 6, 2021 · 974abf3 · 974abf3
1 parent 8a0bc9f
commit 974abf3
Show file tree

Hide file tree

Showing 13 changed files with 25,069 additions and 14,136 deletions.
diff --git a/README.md b/README.md
@@ -23,6 +23,7 @@ ___
 * [`tags` input](#tags-input)
   * [`type=schedule`](#typeschedule)
   * [`type=semver`](#typesemver)
+  * [`type=pep440`](#typepep440)
   * [`type=match`](#typematch)
   * [`type=edge`](#typeedge)
   * [`type=ref`](#typeref)
@@ -384,11 +385,11 @@ tags: |
 ```
 
 Will be used on a [push tag event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#push)
-and requires a valid Git tag [semver](https://semver.org/) but you can also use a custom value through `value`
+and requires a valid [semver](https://semver.org/) Git tag, but you can also use a custom value through `value`
 attribute.
 
 `pattern` attribute supports [Handlebars template](https://handlebarsjs.com/guide/) with the following expressions:
-* `raw` ; the actual semver
+* `raw` ; the actual tag
 * `version` ; shorthand for `{{major}}.{{minor}}.{{patch}}` (can include pre-release)
 * `major` ; major version identifier
 * `minor` ; minor version identifier
@@ -416,6 +417,51 @@ tags: |
   type=semver,enable=true,priority=900,prefix=,suffix=,pattern=,value=
 ```
 
+### `type=pep440`
+
+```yaml
+tags: |
+  # minimal
+  type=pep440,pattern={{version}}
+  # use custom value instead of git tag
+  type=pep440,pattern={{version}},value=1.0.0
+```
+
+Will be used on a [push tag event](https://docs.github.com/en/actions/reference/events-that-trigger-workflows#push)
+and requires a Git tag that conforms to [PEP 440](https://www.python.org/dev/peps/pep-0440/), but you can also use a
+custom value through `value` attribute.
+
+`pattern` attribute supports [Handlebars template](https://handlebarsjs.com/guide/) with the following expressions:
+* `raw` ; the actual tag
+* `version` ; cleaned version
+* `major` ; major version identifier
+* `minor` ; minor version identifier
+* `patch` ; patch version identifier
+
+| Git tag            | Pattern                                                  | Output               |
+|--------------------|----------------------------------------------------------|----------------------|
+| `1.2.3`            | `{{raw}}`                                                | `1.2.3`              |
+| `1.2.3`            | `{{version}}`                                            | `1.2.3`              |
+| `v1.2.3`           | `{{version}}`                                            | `1.2.3`              |
+| `1.2.3`            | `{{major}}.{{minor}}`                                    | `1.2`                |
+| `1.2.3`            | `v{{major}}`                                             | `v1`                 |
+| `1.2.3rc2`         | `{{raw}}`                                                | `1.2.3rc2`*          |
+| `1.2.3rc2`         | `{{version}}`                                            | `1.2.3rc2`           |
+| `1.2.3rc2`         | `{{major}}.{{minor}}`                                    | `1.2.3rc2`*          |
+| `1.2.3post1`       | `{{major}}.{{minor}}`                                    | `1.2.3.post1`*       |
+| `1.2.3beta2`       | `{{major}}.{{minor}}`                                    | `1.2.3b2`*           |
+| `1.0dev4`          | `{{major}}.{{minor}}`                                    | `1.0.dev4`*          |
+
+> *dev/pre/post release will only extend `{{version}}` as tag because they are updated frequently,
+> and contain many breaking changes that are (by the author's design) not yet fit for public consumption.
+
+Extended attributes and default values:
+
+```yaml
+tags: |
+  type=pep440,enable=true,priority=900,prefix=,suffix=,pattern=,value=
+```
+
 ### `type=match`
 
 ```yaml

diff --git a/__tests__/fixtures/event_tag_1.0dev4.env b/__tests__/fixtures/event_tag_1.0dev4.env
@@ -0,0 +1,23 @@
+GITHUB_ACTION=crazy-maxghaction-dump-context
+GITHUB_ACTIONS=true
+GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
+GITHUB_ACTOR=crazy-max
+GITHUB_API_URL=https://api.github.com
+GITHUB_BASE_REF=
+GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_EVENT_NAME=push
+#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
+GITHUB_GRAPHQL_URL=https://api.github.com/graphql
+GITHUB_HEAD_REF=
+GITHUB_JOB=event
+GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_REF=refs/tags/1.0dev4
+GITHUB_REPOSITORY=crazy-max/test-docker-action
+GITHUB_REPOSITORY_OWNER=crazy-max
+GITHUB_RETENTION_DAYS=90
+GITHUB_RUN_ID=325968230
+GITHUB_RUN_NUMBER=4
+GITHUB_SERVER_URL=https://github.com
+GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
+GITHUB_WORKFLOW=event
+GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action
diff --git a/__tests__/fixtures/event_tag_1.1beta2.env b/__tests__/fixtures/event_tag_1.1beta2.env
@@ -0,0 +1,23 @@
+GITHUB_ACTION=crazy-maxghaction-dump-context
+GITHUB_ACTIONS=true
+GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
+GITHUB_ACTOR=crazy-max
+GITHUB_API_URL=https://api.github.com
+GITHUB_BASE_REF=
+GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_EVENT_NAME=push
+#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
+GITHUB_GRAPHQL_URL=https://api.github.com/graphql
+GITHUB_HEAD_REF=
+GITHUB_JOB=event
+GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_REF=refs/tags/1.1beta2
+GITHUB_REPOSITORY=crazy-max/test-docker-action
+GITHUB_REPOSITORY_OWNER=crazy-max
+GITHUB_RETENTION_DAYS=90
+GITHUB_RUN_ID=325968230
+GITHUB_RUN_NUMBER=4
+GITHUB_SERVER_URL=https://github.com
+GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
+GITHUB_WORKFLOW=event
+GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action
diff --git a/__tests__/fixtures/event_tag_1.2.3rc2.env b/__tests__/fixtures/event_tag_1.2.3rc2.env
@@ -0,0 +1,23 @@
+GITHUB_ACTION=crazy-maxghaction-dump-context
+GITHUB_ACTIONS=true
+GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
+GITHUB_ACTOR=crazy-max
+GITHUB_API_URL=https://api.github.com
+GITHUB_BASE_REF=
+GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_EVENT_NAME=push
+#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
+GITHUB_GRAPHQL_URL=https://api.github.com/graphql
+GITHUB_HEAD_REF=
+GITHUB_JOB=event
+GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_REF=refs/tags/1.2.3rc2
+GITHUB_REPOSITORY=crazy-max/test-docker-action
+GITHUB_REPOSITORY_OWNER=crazy-max
+GITHUB_RETENTION_DAYS=90
+GITHUB_RUN_ID=325968230
+GITHUB_RUN_NUMBER=4
+GITHUB_SERVER_URL=https://github.com
+GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
+GITHUB_WORKFLOW=event
+GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action
diff --git a/__tests__/fixtures/event_tag_1.2.env b/__tests__/fixtures/event_tag_1.2.env
@@ -0,0 +1,23 @@
+GITHUB_ACTION=crazy-maxghaction-dump-context
+GITHUB_ACTIONS=true
+GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
+GITHUB_ACTOR=crazy-max
+GITHUB_API_URL=https://api.github.com
+GITHUB_BASE_REF=
+GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_EVENT_NAME=push
+#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
+GITHUB_GRAPHQL_URL=https://api.github.com/graphql
+GITHUB_HEAD_REF=
+GITHUB_JOB=event
+GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_REF=refs/tags/1.2
+GITHUB_REPOSITORY=crazy-max/test-docker-action
+GITHUB_REPOSITORY_OWNER=crazy-max
+GITHUB_RETENTION_DAYS=90
+GITHUB_RUN_ID=325968230
+GITHUB_RUN_NUMBER=4
+GITHUB_SERVER_URL=https://github.com
+GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
+GITHUB_WORKFLOW=event
+GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action
diff --git a/__tests__/fixtures/event_tag_1.2post1.env b/__tests__/fixtures/event_tag_1.2post1.env
@@ -0,0 +1,23 @@
+GITHUB_ACTION=crazy-maxghaction-dump-context
+GITHUB_ACTIONS=true
+GITHUB_ACTION_PATH=/home/runner/work/_actions/crazy-max/ghaction-dump-context/v1
+GITHUB_ACTOR=crazy-max
+GITHUB_API_URL=https://api.github.com
+GITHUB_BASE_REF=
+GITHUB_ENV=/home/runner/work/_temp/_runner_file_commands/set_env_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_EVENT_NAME=push
+#GITHUB_EVENT_PATH=/home/runner/work/_temp/_github_workflow/event.json
+GITHUB_GRAPHQL_URL=https://api.github.com/graphql
+GITHUB_HEAD_REF=
+GITHUB_JOB=event
+GITHUB_PATH=/home/runner/work/_temp/_runner_file_commands/add_path_6ee180c2-b331-434a-a867-89534cbefd83
+GITHUB_REF=refs/tags/1.2post1
+GITHUB_REPOSITORY=crazy-max/test-docker-action
+GITHUB_REPOSITORY_OWNER=crazy-max
+GITHUB_RETENTION_DAYS=90
+GITHUB_RUN_ID=325968230
+GITHUB_RUN_NUMBER=4
+GITHUB_SERVER_URL=https://github.com
+GITHUB_SHA=90dd6032fac8bda1b6c4436a2e65de27961ed071
+GITHUB_WORKFLOW=event
+GITHUB_WORKSPACE=/home/runner/work/test-docker-action/test-docker-action