Merge pull request #256 from crazy-max/fix-readme

Fix README
2023-01-11 16:25:04 +01:00 · 2023-01-11 16:17:34 +01:00 · 2023-01-08 18:33:57 +01:00 · 2023-01-06 09:54:33 +00:00 · 2023-01-06 10:54:03 +01:00 · 2023-01-06 18:11:29 +09:00
10 changed files with 156 additions and 49 deletions
--- a/README.md
+++ b/README.md
@@ -1,6 +1,7 @@
 [![GitHub release](https://img.shields.io/github/release/docker/metadata-action.svg?style=flat-square)](https://github.com/docker/metadata-action/releases/latest)
 [![GitHub marketplace](https://img.shields.io/badge/marketplace-docker--metadata--action-blue?logo=github&style=flat-square)](https://github.com/marketplace/actions/docker-metadata-action)
-[![Test workflow](https://img.shields.io/github/workflow/status/docker/metadata-action/test?label=test&logo=github&style=flat-square)](https://github.com/docker/metadata-action/actions?workflow=test)
+[![CI workflow](https://img.shields.io/github/actions/workflow/status/docker/metadata-action/ci.yml?branch=master&label=ci&logo=github&style=flat-square)](https://github.com/docker/metadata-action/actions?workflow=ci)
+[![Test workflow](https://img.shields.io/github/actions/workflow/status/docker/metadata-action/test.yml?branch=master&label=test&logo=github&style=flat-square)](https://github.com/docker/metadata-action/actions?workflow=test)
 [![Codecov](https://img.shields.io/codecov/c/github/docker/metadata-action?logo=codecov&style=flat-square)](https://codecov.io/gh/docker/metadata-action)

 ## About
@@ -42,7 +43,7 @@ ___
    * [`{{sha}}`](#sha)
    * [`{{base_ref}}`](#base_ref)
    * [`{{is_default_branch}}`](#is_default_branch)
-    * [`{{date '<format>'}}`](#date-format)
+    * [`{{date '<format>' tz='<timezone>'}}`](#date-format-tztimezone)
  * [Major version zero](#major-version-zero)
  * [JSON output object](#json-output-object)
  * [Overwrite labels](#overwrite-labels)
@@ -398,6 +399,8 @@ tags: |
  type=schedule,pattern=nightly
  # handlebars
  type=schedule,pattern={{date 'YYYYMMDD'}}
+  # handlebars with timezone
+  type=schedule,pattern={{date 'YYYYMMDD-hhmmss' tz='Asia/Tokyo'}}
 ```

 Will be used on [schedule event](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#schedule).
@@ -405,12 +408,14 @@ Will be used on [schedule event](https://docs.github.com/en/actions/using-workfl
 `pattern` is a specially crafted attribute to support [Handlebars' template](https://handlebarsjs.com/guide/)
 with the following expressions:

-* `date 'format'` ; render date by its [moment format](https://momentjs.com/docs/#/displaying/format/)
+* `date 'format' tz='Timezone'` ; render date by its [moment format](https://momentjs.com/docs/#/displaying/format/).
+  Default `tz` is UTC.

-| Pattern                  | Output               |
-|--------------------------|----------------------|
-| `nightly`                | `nightly`            |
-| `{{date 'YYYYMMDD'}}`    | `20210326`           |
+| Pattern                                      | Output            |
+|----------------------------------------------|-------------------|
+| `nightly`                                    | `nightly`         |
+| `{{date 'YYYYMMDD'}}`                        | `20200110`        |
+| `{{date 'YYYYMMDD-HHmmss' tz='Asia/Tokyo'}}` | `20200110-093000` |

 Extended attributes and default values:

@@ -775,14 +780,16 @@ workflow run. Will be empty for a branch reference:
 Returns `true` if the branch that triggered the workflow run is the default
 one, otherwise `false`.

-#### `{{date '<format>'}}`
+#### `{{date '<format>' tz='<timezone>'}}`

 Returns the current date rendered by its [moment format](https://momentjs.com/docs/#/displaying/format/).
+Default `tz` is UTC.

-| Expression                                 | Output example                          |
-|--------------------------------------------|-----------------------------------------|
-| `{{date 'YYYYMMDD'}}`                      | `20200110`                              |
-| `{{date 'dddd, MMMM Do YYYY, h:mm:ss a'}}` | `Friday, January 10th 2020, 3:25:50 pm` |
+| Expression                                   | Output example                          |
+|----------------------------------------------|-----------------------------------------|
+| `{{date 'YYYYMMDD'}}`                        | `20200110`                              |
+| `{{date 'dddd, MMMM Do YYYY, h:mm:ss a'}}`   | `Friday, January 10th 2020, 3:25:50 pm` |
+| `{{date 'YYYYMMDD-HHmmss' tz='Asia/Tokyo'}}` | `20200110-093000`                       |

 ### Major version zero

--- a/tests/meta.test.ts
+++ b/tests/meta.test.ts
@@ -2,7 +2,7 @@ import {beforeEach, describe, expect, jest, test} from '@jest/globals';
 import * as fs from 'fs';
 import * as path from 'path';
 import * as dotenv from 'dotenv';
-import * as moment from 'moment';
+import moment from 'moment-timezone';
 import {getInputs, Inputs} from '../src/context';
 import * as github from '../src/github';
 import {Meta, Version} from '../src/meta';
@@ -21,8 +21,8 @@ jest.spyOn(global.Date.prototype, 'toISOString').mockImplementation(() => {
  return '2020-01-10T00:30:00.000Z';
 });

-jest.mock('moment', () => {
-  return () => (jest.requireActual('moment') as typeof import('moment'))('2020-01-10T00:30:00.000Z');
+jest.mock('moment-timezone', () => {
+  return () => (jest.requireActual('moment-timezone') as typeof import('moment-timezone'))('2020-01-10T00:30:00.000Z');
 });

 beforeEach(() => {
@@ -599,6 +599,7 @@ describe('push', () => {
        tags: [
          `type=raw,value=mytag-{{branch}}`,
          `type=raw,value=mytag-{{date 'YYYYMMDD'}}`,
+          `type=raw,value=mytag-{{date 'YYYYMMDD-HHmmss' tz='Asia/Tokyo'}}`,
          `type=raw,value=mytag-tag-{{tag}}`,
          `type=raw,value=mytag-baseref-{{base_ref}}`,
          `type=raw,value=mytag-defbranch,enable={{is_default_branch}}`
@@ -608,6 +609,7 @@ describe('push', () => {
        main: 'mytag-master',
        partial: [
          'mytag-20200110',
+          'mytag-20200110-093000',
          'mytag-tag-',
          'mytag-baseref-',
          'mytag-defbranch'
@@ -617,6 +619,7 @@ describe('push', () => {
      [
        'user/app:mytag-master',
        'user/app:mytag-20200110',
+        'user/app:mytag-20200110-093000',
        'user/app:mytag-tag-',
        'user/app:mytag-baseref-',
        'user/app:mytag-defbranch'
@@ -2995,6 +2998,34 @@ describe('schedule', () => {
        "org.opencontainers.image.licenses=MIT"
      ]
    ],
+    [
+      'schedule08',
+      'event_schedule.env',
+      {
+        images: ['user/app'],
+        tags: [
+          `type=schedule,pattern={{date 'YYYYMMDD-HHmmss' tz='Asia/Tokyo'}}`
+        ]
+      } as Inputs,
+      {
+        main: '20200110-093000',
+        partial: [],
+        latest: false
+      } as Version,
+      [
+        'user/app:20200110-093000'
+      ],
+      [
+        "org.opencontainers.image.title=Hello-World",
+        "org.opencontainers.image.description=This your first repo!",
+        "org.opencontainers.image.url=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.source=https://github.com/octocat/Hello-World",
+        "org.opencontainers.image.version=20200110-093000",
+        "org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
+        "org.opencontainers.image.revision=860c1904a1ce19322e91ac35af1ab07466440c37",
+        "org.opencontainers.image.licenses=MIT"
+      ]
+    ],
  ])('given %p with %p event', tagsLabelsTest);
 });

--- a/tests/tag.test.ts
+++ b/tests/tag.test.ts
@@ -126,6 +126,18 @@ describe('parse', () => {
      } as Tag,
      false
    ],
+    [
+      `type=schedule,enable=true,pattern={{date 'YYYYMMDD' tz='Asia/Tokyo'}}`,
+      {
+        type: Type.Schedule,
+        attrs: {
+          "priority": DefaultPriorities[Type.Schedule],
+          "enable": "true",
+          "pattern": `{{date 'YYYYMMDD' tz='Asia/Tokyo'}}`
+        }
+      } as Tag,
+      false
+    ],
    [
      `type=semver,enable=true,pattern={{version}}`,
      {
--- a/dist/index.js
+++ b/dist/index.js
--- a/dist/index.js.map
+++ b/dist/index.js.map
--- a/dist/licenses.txt
+++ b/dist/licenses.txt
@@ -627,6 +627,29 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.


+moment-timezone
+MIT
+The MIT License (MIT)
+
+Copyright (c) JS Foundation and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
 node-fetch
 MIT
 The MIT License (MIT)
--- a/package.json
+++ b/package.json
@@ -32,9 +32,10 @@
    "@actions/core": "^1.10.0",
    "@actions/github": "^5.1.1",
    "@renovate/pep440": "^1.0.0",
-    "csv-parse": "^5.3.1",
+    "csv-parse": "^5.3.3",
    "handlebars": "^4.7.7",
    "moment": "^2.29.4",
+    "moment-timezone": "^0.5.40",
    "semver": "^7.3.7"
  },
  "devDependencies": {
--- a/src/meta.ts
+++ b/src/meta.ts
@@ -1,7 +1,7 @@
 import * as handlebars from 'handlebars';
 import * as fs from 'fs';
 import * as path from 'path';
-import moment from 'moment';
+import moment from 'moment-timezone';
 import * as pep440 from '@renovate/pep440';
 import * as semver from 'semver';
 import {Inputs, tmpDir} from './context';
@@ -129,8 +129,19 @@ export class Meta {
    const currentDate = this.date;
    const vraw = this.setValue(
      handlebars.compile(tag.attrs['pattern'])({
-        date: function (format) {
-          return moment(currentDate).utc().format(format);
+        date: function (format, options) {
+          const m = moment(currentDate);
+          let tz = 'UTC';
+          Object.keys(options.hash).forEach(key => {
+            switch (key) {
+              case 'tz':
+                tz = options.hash[key];
+                break;
+              default:
+                throw new Error(`Unknown ${key} attribute`);
+            }
+          });
+          return m.tz(tz).format(format);
        }
      }),
      tag
@@ -411,8 +422,19 @@ export class Meta {
        }
        return 'false';
      },
-      date: function (format) {
-        return moment(currentDate).utc().format(format);
+      date: function (format, options) {
+        const m = moment(currentDate);
+        let tz = 'UTC';
+        Object.keys(options.hash).forEach(key => {
+          switch (key) {
+            case 'tz':
+              tz = options.hash[key];
+              break;
+            default:
+              throw new Error(`Unknown ${key} attribute`);
+          }
+        });
+        return m.tz(tz).format(format);
      }
    });
  }
--- a/src/tag.ts
+++ b/src/tag.ts
@@ -95,7 +95,7 @@ export function Parse(s: string): Tag {
  for (const field of fields) {
    const parts = field
      .toString()
-      .split('=')
+      .split(/(?<=^[^=]+?)=/)
      .map(item => item.trim());
    if (parts.length == 1) {
      tag.attrs['value'] = parts[0];
--- a/yarn.lock
+++ b/yarn.lock
@@ -1560,7 +1560,7 @@ combined-stream@^1.0.8:
 concat-map@0.0.1:
  version "0.0.1"
  resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
-  integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=
+  integrity sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==

 convert-source-map@^1.4.0, convert-source-map@^1.6.0, convert-source-map@^1.7.0:
  version "1.8.0"
@@ -1605,10 +1605,10 @@ cssstyle@^2.3.0:
  dependencies:
    cssom "~0.3.6"

-csv-parse@*, csv-parse@^5.3.1:
-  version "5.3.1"
-  resolved "https://registry.yarnpkg.com/csv-parse/-/csv-parse-5.3.1.tgz#78b028eb2d2a3e16e62ee8abe710ff7a0b1f8b3b"
-  integrity sha512-R4Hv6eGJNzgcKdThZ6XORbSQ873HVcNke74QIq+LbwpT90LaZ8Xzl7KKiuIP16xq/P7ofzRt0h7S0xm+fVScsw==
+csv-parse@*, csv-parse@^5.3.3:
+  version "5.3.3"
+  resolved "https://registry.yarnpkg.com/csv-parse/-/csv-parse-5.3.3.tgz#3b75d2279e2edb550cbc54c65b25cbbf3d0033ad"
+  integrity sha512-kEWkAPleNEdhFNkHQpFHu9RYPogsFj3dx6bCxL847fsiLgidzWg0z/O0B1kVWMJUc5ky64zGp18LX2T3DQrOfw==

 data-urls@^2.0.0:
  version "2.0.0"
@@ -2822,11 +2822,9 @@ json-stable-stringify-without-jsonify@^1.0.1:
  integrity sha1-nbe1lJatPzz+8wp1FC0tkwrXJlE=

 json5@2.x, json5@^2.1.2:
-  version "2.2.0"
-  resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.0.tgz#2dfefe720c6ba525d9ebd909950f0515316c89a3"
-  integrity sha512-f+8cldu7X/y7RAJurMEJmdoKXGB/X550w2Nr3tTbezL6RwEE/iMcm+tZnXeoZtKuOq6ft8+CqzEkrIgx1fPoQA==
-  dependencies:
-    minimist "^1.2.5"
+  version "2.2.3"
+  resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283"
+  integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg==

 kleur@^3.0.3:
  version "3.0.3"
@@ -2943,9 +2941,9 @@ mimic-fn@^2.1.0:
  integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==

 minimatch@^3.0.4:
-  version "3.0.4"
-  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083"
-  integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==
+  version "3.1.2"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b"
+  integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==
  dependencies:
    brace-expansion "^1.1.7"

@@ -2954,7 +2952,14 @@ minimist@^1.2.5:
  resolved "https://registry.yarnpkg.com/minimist/-/minimist-1.2.6.tgz#8637a5b759ea0d6e98702cfb3a9283323c93af44"
  integrity sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==

-moment@^2.29.4:
+moment-timezone@^0.5.40:
+  version "0.5.40"
+  resolved "https://registry.yarnpkg.com/moment-timezone/-/moment-timezone-0.5.40.tgz#c148f5149fd91dd3e29bf481abc8830ecba16b89"
+  integrity sha512-tWfmNkRYmBkPJz5mr9GVDn9vRlVZOTe6yqY92rFxiOdWXbjaR0+9LwQnZGGuNR63X456NqmEkbskte8tWL5ePg==
+  dependencies:
+    moment ">= 2.9.0"
+
+"moment@>= 2.9.0", moment@^2.29.4:
  version "2.29.4"
  resolved "https://registry.yarnpkg.com/moment/-/moment-2.29.4.tgz#3dbe052889fe7c1b2ed966fcb3a77328964ef108"
  integrity sha512-5LC9SOxjSc2HF6vO2CyuTDNivEdoz2IvyJJGj6X8DJ0eFyfszE0QiEd+iXmBvUP3WHxSjFH/vIsA0EN00cgr8w==
Author	SHA1	Message	Date
CrazyMax	05d22bf317	Merge pull request #256 from crazy-max/fix-readme Fix README	2023-01-11 16:25:04 +01:00
CrazyMax	70b403b46b	Fix README Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>	2023-01-11 16:17:34 +01:00
CrazyMax	9e6ae02878	Merge pull request #252 from docker/dependabot/npm_and_yarn/json5-2.2.3 Bump json5 from 2.2.0 to 2.2.3	2023-01-08 18:33:57 +01:00
dependabot[bot]	3d239e8b8a	Bump json5 from 2.2.0 to 2.2.3 Bumps [json5](https://github.com/json5/json5) from 2.2.0 to 2.2.3. - [Release notes](https://github.com/json5/json5/releases) - [Changelog](https://github.com/json5/json5/blob/main/CHANGELOG.md) - [Commits](https://github.com/json5/json5/compare/v2.2.0...v2.2.3) --- updated-dependencies: - dependency-name: json5 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2023-01-06 09:54:33 +00:00
CrazyMax	7cb52e2750	Merge pull request #251 from chroju/set_timezone Add tz attribute to handlebar date function	2023-01-06 10:54:03 +01:00
chroju	90a1d5cf21	Add tz attribute to handlebar date function Signed-off-by: chroju <chroju@users.noreply.github.com>	2023-01-06 18:11:29 +09:00
CrazyMax	c98ac5e987	Merge pull request #249 from crazy-max/fix-readme readme: fix badges	2022-12-19 21:11:06 +01:00
CrazyMax	44d853bc0a	readme: fix badges Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>	2022-12-19 21:07:37 +01:00
CrazyMax	d1abf80723	Merge pull request #245 from docker/dependabot/npm_and_yarn/csv-parse-5.3.3 Bump csv-parse from 5.3.1 to 5.3.3	2022-12-19 21:05:43 +01:00
CrazyMax	3358a27538	update generated content Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>	2022-12-19 21:02:10 +01:00
CrazyMax	314ddf6d4a	Merge pull request #242 from docker/dependabot/npm_and_yarn/minimatch-3.1.2 Bump minimatch from 3.0.4 to 3.1.2	2022-11-29 18:53:57 +01:00
dependabot[bot]	b91e8f52b0	Bump csv-parse from 5.3.1 to 5.3.3 Bumps [csv-parse](https://github.com/adaltas/node-csv/tree/HEAD/packages/csv-parse) from 5.3.1 to 5.3.3. - [Release notes](https://github.com/adaltas/node-csv/releases) - [Changelog](https://github.com/adaltas/node-csv/blob/master/packages/csv-parse/CHANGELOG.md) - [Commits](https://github.com/adaltas/node-csv/commits/csv-parse@5.3.3/packages/csv-parse) --- updated-dependencies: - dependency-name: csv-parse dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2022-11-28 19:04:37 +00:00
dependabot[bot]	fbac5f9bca	Bump minimatch from 3.0.4 to 3.1.2 Bumps [minimatch](https://github.com/isaacs/minimatch) from 3.0.4 to 3.1.2. - [Release notes](https://github.com/isaacs/minimatch/releases) - [Commits](https://github.com/isaacs/minimatch/compare/v3.0.4...v3.1.2) --- updated-dependencies: - dependency-name: minimatch dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>	2022-11-10 03:52:53 +00:00