From 0c395ebe6274b8ea3176526cd68c6b92ff64a880 Mon Sep 17 00:00:00 2001 From: CrazyMax <1951866+crazy-max@users.noreply.github.com> Date: Tue, 19 Nov 2024 15:36:40 +0100 Subject: [PATCH] commit_date: code cleanup and readme updates Signed-off-by: CrazyMax <1951866+crazy-max@users.noreply.github.com> --- README.md | 10 ++++++---- __tests__/context.test.ts | 2 +- __tests__/meta.test.ts | 3 ++- 3 files changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bd52f570..ac406154 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,7 @@ ___ * [`{{base_ref}}`](#base_ref) * [`{{is_default_branch}}`](#is_default_branch) * [`{{date '' tz=''}}`](#date-format-tztimezone) + * [`{{commit_date '' tz=''}}`](#commit_date-format-tztimezone) * [Major version zero](#major-version-zero) * [JSON output object](#json-output-object) * [Overwrite labels and annotations](#overwrite-labels-and-annotations) @@ -891,13 +892,14 @@ Default `tz` is UTC. #### `{{commit_date '' tz=''}}` -Returns the date when current git commit is committed. -rendered by its [moment format](https://momentjs.com/docs/#/displaying/format/). +Returns the date when the current git commit is committed, rendered by its +[moment format](https://momentjs.com/docs/#/displaying/format/). It falls back +to the current date if the commit date is not available. Default `tz` is UTC. -| Expression | Output example | -|----------------------------------------------|-----------------------------------------| +| Expression | Output example | +|-----------------------------------------------------|-----------------------------------------| | `{{commit_date 'YYYYMMDD'}}` | `20200110` | | `{{commit_date 'dddd, MMMM Do YYYY, h:mm:ss a'}}` | `Friday, January 10th 2020, 3:25:50 pm` | | `{{commit_date 'YYYYMMDD-HHmmss' tz='Asia/Tokyo'}}` | `20200110-093000` | diff --git a/__tests__/context.test.ts b/__tests__/context.test.ts index ef8c3649..6bd141ba 100644 --- a/__tests__/context.test.ts +++ b/__tests__/context.test.ts @@ -5,9 +5,9 @@ import * as path from 'path'; import {Context} from '@actions/github/lib/context'; import {Git} from '@docker/actions-toolkit/lib/git'; import {GitHub} from '@docker/actions-toolkit/lib/github'; +import {Toolkit} from '@docker/actions-toolkit/lib/toolkit'; import {ContextSource, getContext, getInputs, Inputs} from '../src/context'; -import {Toolkit} from '@docker/actions-toolkit/lib/toolkit'; const toolkit = new Toolkit({githubToken: 'fake-github-token'}); diff --git a/__tests__/meta.test.ts b/__tests__/meta.test.ts index e3597470..e8f1bbd8 100644 --- a/__tests__/meta.test.ts +++ b/__tests__/meta.test.ts @@ -2,10 +2,11 @@ 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 {Context} from '@actions/github/lib/context'; import {GitHub} from '@docker/actions-toolkit/lib/github'; import {Toolkit} from '@docker/actions-toolkit/lib/toolkit'; import {GitHubRepo} from '@docker/actions-toolkit/lib/types/github'; -import {Context} from '@actions/github/lib/context'; import {ContextSource, getContext, getInputs, Inputs} from '../src/context'; import {Meta, Version} from '../src/meta';