huoxue1
/
metadata-action
mirror of https://github.com/docker/metadata-action.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Allow to templatize schedule tag (#1) 

Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
This commit is contained in:
CrazyMax 2020-10-25 15:13:43 +01:00 committed by GitHub
parent 88d487154b
commit 3b38d53d94
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 14262 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
.github/workflows/ci.yml vendored
View File

@ -2,7 +2,7 @@ name: ci
on:
schedule:
- cron: '0 10 * * 0' # everyday sunday at 10am
- cron: '0 * * * *' # every hours
push:
branches:
- '**'
@ -22,7 +22,6 @@ jobs:
uses: actions/checkout@v2.3.3
-
name: Docker meta
id: docker_meta
uses: ./
with:
images: |
@ -30,6 +29,30 @@ jobs:
ghcr.io/name/app
tag-sha: true
tag-schedule:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
tag-schedule:
- ""
- "cron-{{date 'YYYYMMDD'}}"
- "{{date 'YYYYMMDD-HHmmss'}}"
- "schedule"
steps:
-
name: Checkout
uses: actions/checkout@v2.3.3
-
name: Docker meta
uses: ./
with:
images: |
${{ env.DOCKER_IMAGE }}
ghcr.io/name/app
tag-sha: true
tag-schedule: ${{ matrix.tag-schedule }}
docker-push:
runs-on: ubuntu-latest
services:

22
README.md
View File

@ -21,6 +21,8 @@ ___
* [Customizing](#customizing)
* [inputs](#inputs)
* [outputs](#outputs)
* [Notes](#notes)
* [Templates available for schedule tag](#templates-available-for-schedule-tag)
* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot)
* [How can I help?](#how-can-i-help)
* [License](#license)
@ -34,13 +36,13 @@ ___
| Event | Ref | Commit SHA | Docker Tag | Pushed |
|-----------------|-------------------------------|------------|------------------------------------|--------|
| `schedule` | | | `nightly` | Yes |
| `schedule` | | `45f132a` | `sha-45f132a`, `nightly` | Yes |
| `pull_request` | `refs/pull/2/merge` | `a123b57` | `sha-a123b57`, `pr-2` | No |
| `push` | `refs/heads/<default_branch>` | `676cae2` | `sha-676cae2`, `edge` | Yes |
| `push` | `refs/heads/dev` | `cf20257` | `sha-cf20257`, `dev` | Yes |
| `push` | `refs/heads/my/branch` | `a5df687` | `sha-a5df687`, `my-branch` | Yes |
| `push tag` | `refs/tags/v1.2.3` | | `1.2.3`, `latest` | Yes |
| `push tag` | `refs/tags/mytag` | | `mytag` | Yes |
| `push tag` | `refs/tags/v1.2.3` | `bf4565b` | `sha-bf4565b`, `1.2.3`, `latest` | Yes |
| `push tag` | `refs/tags/mytag` | `afb7833` | `sha-afb7833`, `mytag` | Yes |
```yaml
name: ci
@ -107,6 +109,7 @@ Following inputs can be used as `step.with` keys
| `images` | List/CSV | List of Docker images to use as base name for tags |
| `tag-sha` | Bool | Add git short SHA as Docker tag (default `false`) |
| `tag-edge` | String | Branch that will be tagged as edge (default `repo.default_branch`) |
| `tag-schedule` | String | [Handlebars template](https://handlebarsjs.com/guide/) to apply to schedule tag (default `nightly`) |
| `sep-tags` | String | Separator to use for tags output (default `\n`) |
| `sep-labels` | String | Separator to use for labels output (default `\n`) |
@ -122,6 +125,19 @@ Following outputs are available
| `tags` | String | Generated Docker tags |
| `labels` | String | Generated Docker labels |
## Notes
### Templates available for schedule tag
`tag-schedule` is specially crafted input to support [Handlebars template](https://handlebarsjs.com/guide/) with
the following expressions:
| Expression | Example | Description |
|-------------------------|-------------------------------------------|------------------------------------------|
| `{{date 'format'}}` | `{{date 'YYYYMMDD'}}` > `20200110` | Render date by its [moment format](https://momentjs.com/docs/#/displaying/format/)
You can find more examples in the [CI workflow](.github/workflows/ci.yml).
## Keep up-to-date with GitHub Dependabot
Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot)

105
__tests__/meta.test.ts
View File

@ -1,7 +1,8 @@
import * as fs from 'fs';
import * as path from 'path';
import * as dotenv from 'dotenv';
import {Inputs} from '../src/context';
import * as moment from 'moment';
import {getInputs, Inputs} from '../src/context';
import * as github from '../src/github';
import {Meta} from '../src/meta';
import {Context} from '@actions/github/lib/context';
@ -23,6 +24,10 @@ jest.spyOn(global.Date.prototype, 'toISOString').mockImplementation(() => {
return '2020-01-10T00:30:00.000Z';
});
jest.mock('moment', () => {
return () => jest.requireActual('moment')('2020-01-10T00:30:00.000Z');
});
describe('tags and labels', () => {
beforeEach(() => {
Object.keys(process.env).forEach(function (key) {
@ -38,7 +43,7 @@ describe('tags and labels', () => {
'event_null.env',
{
images: ['user/app'],
},
} as Inputs,
undefined,
[],
[
@ -56,7 +61,7 @@ describe('tags and labels', () => {
'event_empty.env',
{
images: ['user/app'],
},
} as Inputs,
undefined,
[],
[
@ -74,7 +79,7 @@ describe('tags and labels', () => {
'event_pull_request.env',
{
images: ['user/app'],
},
} as Inputs,
'pr-2',
[
'user/app:pr-2'
@ -94,7 +99,7 @@ describe('tags and labels', () => {
'event_push.env',
{
images: ['user/app'],
},
} as Inputs,
'dev',
[
'user/app:dev'
@ -114,7 +119,7 @@ describe('tags and labels', () => {
'event_push_defbranch.env',
{
images: ['user/app'],
},
} as Inputs,
'edge',
[
'user/app:edge'
@ -134,7 +139,7 @@ describe('tags and labels', () => {
'event_release.env',
{
images: ['user/app'],
},
} as Inputs,
'1.1.1',
[
'user/app:1.1.1',
@ -155,7 +160,7 @@ describe('tags and labels', () => {
'event_schedule.env',
{
images: ['user/app'],
},
} as Inputs,
'nightly',
[
'user/app:nightly'
@ -171,11 +176,53 @@ describe('tags and labels', () => {
"org.opencontainers.image.licenses=MIT"
]
],
[
'event_schedule.env',
{
images: ['user/app'],
tagSchedule: `{{date 'YYYYMMDD'}}`
} as Inputs,
'20200110',
[
'user/app:20200110'
],
[
"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.git",
"org.opencontainers.image.version=20200110",
"org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
"org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
"org.opencontainers.image.licenses=MIT"
]
],
[
'event_schedule.env',
{
images: ['user/app'],
tagSchedule: `{{date 'YYYYMMDD-HHmmss'}}`
} as Inputs,
'20200110-003000',
[
'user/app:20200110-003000'
],
[
"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.git",
"org.opencontainers.image.version=20200110-003000",
"org.opencontainers.image.created=2020-01-10T00:30:00.000Z",
"org.opencontainers.image.revision=90dd6032fac8bda1b6c4436a2e65de27961ed071",
"org.opencontainers.image.licenses=MIT"
]
],
[
'event_tag.env',
{
images: ['user/app'],
},
} as Inputs,
'release1',
[
'user/app:release1'
@ -195,7 +242,7 @@ describe('tags and labels', () => {
'event_tag_semver.env',
{
images: ['user/app'],
},
} as Inputs,
'1.1.1',
[
'user/app:1.1.1',
@ -216,7 +263,7 @@ describe('tags and labels', () => {
'event_workflow_dispatch.env',
{
images: ['user/app'],
},
} as Inputs,
'edge',
[
'user/app:edge'
@ -236,7 +283,7 @@ describe('tags and labels', () => {
'event_pull_request.env',
{
images: ['org/app', 'ghcr.io/user/app'],
},
} as Inputs,
'pr-2',
[
'org/app:pr-2',
@ -257,7 +304,7 @@ describe('tags and labels', () => {
'event_push.env',
{
images: ['org/app', 'ghcr.io/user/app'],
},
} as Inputs,
'dev',
[
'org/app:dev',
@ -278,7 +325,7 @@ describe('tags and labels', () => {
'event_push_defbranch.env',
{
images: ['org/app', 'ghcr.io/user/app'],
},
} as Inputs,
'edge',
[
'org/app:edge',
@ -299,7 +346,7 @@ describe('tags and labels', () => {
'event_schedule.env',
{
images: ['org/app', 'ghcr.io/user/app'],
},
} as Inputs,
'nightly',
[
'org/app:nightly',
@ -320,7 +367,7 @@ describe('tags and labels', () => {
'event_tag_semver.env',
{
images: ['org/app', 'ghcr.io/user/app'],
},
} as Inputs,
'1.1.1',
[
'org/app:1.1.1',
@ -344,7 +391,7 @@ describe('tags and labels', () => {
{
images: ['org/app', 'ghcr.io/user/app'],
tagSha: true,
},
} as Inputs,
'pr-2',
[
'org/app:pr-2',
@ -368,7 +415,7 @@ describe('tags and labels', () => {
{
images: ['org/app', 'ghcr.io/user/app'],
tagSha: true,
},
} as Inputs,
'dev',
[
'org/app:dev',
@ -392,7 +439,7 @@ describe('tags and labels', () => {
{
images: ['org/app', 'ghcr.io/user/app'],
tagSha: true,
},
} as Inputs,
'edge',
[
'org/app:edge',
@ -416,7 +463,7 @@ describe('tags and labels', () => {
{
images: ['org/app', 'ghcr.io/user/app'],
tagSha: true,
},
} as Inputs,
'nightly',
[
'org/app:nightly',
@ -440,7 +487,7 @@ describe('tags and labels', () => {
{
images: ['org/app', 'ghcr.io/user/app'],
tagSha: true,
},
} as Inputs,
'1.1.1',
[
'org/app:1.1.1',
@ -467,7 +514,7 @@ describe('tags and labels', () => {
images: ['org/app', 'ghcr.io/user/app'],
tagSha: true,
tagEdge: 'dev'
},
} as Inputs,
'edge',
[
'org/app:edge',
@ -492,7 +539,7 @@ describe('tags and labels', () => {
images: ['org/app', 'ghcr.io/user/app'],
tagSha: true,
tagEdge: 'dev'
},
} as Inputs,
'master',
[
'org/app:master',
@ -513,24 +560,22 @@ describe('tags and labels', () => {
],
])('given %p event ', async (envFile, inputs, exVersion, exTags, exLabels) => {
process.env = dotenv.parse(fs.readFileSync(path.join(__dirname, 'fixtures', envFile)));
console.log(process.env);
const context = github.context();
console.log(context);
console.log(process.env, context);
const repo = await github.repo(process.env.GITHUB_TOKEN || '');
const meta = new Meta(inputs as Inputs, context, repo);
const meta = new Meta({...getInputs(), ...inputs}, context, repo);
const version = meta.version();
console.log(version)
console.log('version', version);
expect(version).toEqual(exVersion);
const tags = meta.tags();
console.log(tags)
console.log('tags', tags);
expect(tags).toEqual(exTags);
const labels = meta.labels();
console.log(labels)
console.log('labels', labels);
expect(labels).toEqual(exLabels);
});
});

4
action.yml
View File

@ -17,6 +17,10 @@ inputs:
tag-edge:
description: 'Branch that will be tagged as edge (default repo.default_branch)'
required: false
tag-schedule:
description: 'Handlebars template to apply to schedule tag'
default: 'nightly'
required: false
sep-tags:
description: 'Separator to use for tags output (default \n)'
required: false

14091
dist/index.js generated vendored
View File

File diff suppressed because one or more lines are too long

2
package.json
View File

@ -25,6 +25,8 @@
"dependencies": {
"@actions/core": "^1.2.6",
"@actions/github": "^4.0.0",
"handlebars": "^4.7.6",
"moment": "^2.29.1",
"semver": "^7.3.2"
},
"devDependencies": {

2
src/context.ts
View File

@ -4,6 +4,7 @@ export interface Inputs {
images: string[];
tagSha: boolean;
tagEdge: string;
tagSchedule: string;
sepTags: string;
sepLabels: string;
githubToken: string;
@ -14,6 +15,7 @@ export function getInputs(): Inputs {
images: getInputList('images'),
tagSha: /true/i.test(core.getInput('tag-sha')),
tagEdge: core.getInput('tag-edge'),
tagSchedule: core.getInput('tag-schedule') || 'nightly',
sepTags: core.getInput('sep-tags') || `\n`,
sepLabels: core.getInput('sep-labels') || `\n`,
githubToken: core.getInput('github-token')

2
src/main.ts
View File

@ -31,7 +31,7 @@ async function run() {
core.startGroup(`Docker image version`);
core.info(`${version}`);
core.endGroup();
core.setOutput('version', version);
core.setOutput('version', version || '');
const tags: Array<string> = meta.tags();
core.startGroup(`Docker tags`);

24
src/meta.ts
View File

@ -1,3 +1,5 @@
import * as handlebars from 'handlebars';
import * as moment from 'moment';
import * as semver from 'semver';
import {Inputs} from './context';
import * as core from '@actions/core';
@ -8,6 +10,7 @@ export class Meta {
private readonly inputs: Inputs;
private readonly context: Context;
private readonly repo: ReposGetResponseData;
private readonly date: Date;
constructor(inputs: Inputs, context: Context, repo: ReposGetResponseData) {
this.inputs = inputs;
@ -16,11 +19,12 @@ export class Meta {
}
this.context = context;
this.repo = repo;
this.date = new Date();
}
public version(): string | undefined {
if (/schedule/.test(this.context.eventName)) {
return 'nightly';
return handlebars.compile(this.inputs.tagSchedule)(this.scheduleTplContext());
} else if (/^refs\/tags\//.test(this.context.ref)) {
const tag = this.context.ref.replace(/^refs\/tags\//g, '').replace(/\//g, '-');
const sver = semver.clean(tag);
@ -38,7 +42,7 @@ export class Meta {
let tags: Array<string> = [];
for (const image of this.inputs.images) {
if (/schedule/.test(this.context.eventName)) {
tags.push.apply(tags, Meta.eventSchedule(image));
tags.push.apply(tags, this.eventSchedule(image));
} else if (/^refs\/tags\//.test(this.context.ref)) {
tags.push.apply(tags, this.eventTag(image));
} else if (/^refs\/heads\//.test(this.context.ref)) {
@ -62,14 +66,15 @@ export class Meta {
`org.opencontainers.image.url=${this.repo.html_url || ''}`,
`org.opencontainers.image.source=${this.repo.clone_url || ''}`,
`org.opencontainers.image.version=${this.version() || ''}`,
`org.opencontainers.image.created=${new Date().toISOString()}`,
`org.opencontainers.image.created=${this.date.toISOString()}`,
`org.opencontainers.image.revision=${this.context.sha || ''}`,
`org.opencontainers.image.licenses=${this.repo.license?.spdx_id || ''}`
];
}
private static eventSchedule(image: string): Array<string> {
return [`${image}:nightly`];
private eventSchedule(image: string): Array<string> {
const schedule = handlebars.compile(this.inputs.tagSchedule)(this.scheduleTplContext());
return [`${image}:${schedule}`];
}
private eventTag(image: string): Array<string> {
@ -93,4 +98,13 @@ export class Meta {
const pr = this.context.ref.replace(/^refs\/pull\//g, '').replace(/\/merge$/g, '');
return [`${image}:pr-${pr}`];
}
private scheduleTplContext(): any {
const currentDate = this.date;
return {
date: function (format) {
return moment(currentDate).utc().format(format);
}
};
}
}

32
yarn.lock
View File

@ -1622,6 +1622,18 @@ growly@^1.3.0:
resolved "https://registry.yarnpkg.com/growly/-/growly-1.3.0.tgz#f10748cbe76af964b7c96c93c6bcc28af120c081"
integrity sha1-8QdIy+dq+WS3yWyTxrzCivEgwIE=
handlebars@^4.7.6:
version "4.7.6"
resolved "https://registry.yarnpkg.com/handlebars/-/handlebars-4.7.6.tgz#d4c05c1baf90e9945f77aa68a7a219aa4a7df74e"
integrity sha512-1f2BACcBfiwAfStCKZNrUCgqNZkGsAT7UM3kkYtXuLo0KnaVfjKOyf7PRzB6++aK9STyT1Pd2ZCPe3EGOXleXA==
dependencies:
minimist "^1.2.5"
neo-async "^2.6.0"
source-map "^0.6.1"
wordwrap "^1.0.0"
optionalDependencies:
uglify-js "^3.1.4"
har-schema@^2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/har-schema/-/har-schema-2.0.0.tgz#a94c2224ebcac04782a0d9035521f24735b7ec92"
@ -2638,6 +2650,11 @@ mkdirp@1.x:
resolved "https://registry.yarnpkg.com/mkdirp/-/mkdirp-1.0.4.tgz#3eb5ed62622756d79a5f0e2a221dfebad75c2f7e"
integrity sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==
moment@^2.29.1:
version "2.29.1"
resolved "https://registry.yarnpkg.com/moment/-/moment-2.29.1.tgz#b2be769fa31940be9eeea6469c075e35006fa3d3"
integrity sha512-kHmoybcPV8Sqy59DwNDY3Jefr64lK/by/da0ViFcuA4DH0vQg5Q6Ze5VimxkfQNSC+Mls/Kx53s7TjP1RhFEDQ==
ms@2.0.0:
version "2.0.0"
resolved "https://registry.yarnpkg.com/ms/-/ms-2.0.0.tgz#5608aeadfc00be6c2901df5f9861788de0d597c8"
@ -2670,6 +2687,11 @@ natural-compare@^1.4.0:
resolved "https://registry.yarnpkg.com/natural-compare/-/natural-compare-1.4.0.tgz#4abebfeed7541f2c27acfb29bdbbd15c8d5ba4f7"
integrity sha1-Sr6/7tdUHywnrPspvbvRXI1bpPc=
neo-async@^2.6.0:
version "2.6.2"
resolved "https://registry.yarnpkg.com/neo-async/-/neo-async-2.6.2.tgz#b4aafb93e3aeb2d8174ca53cf163ab7d7308305f"
integrity sha512-Yd3UES5mWCSqR+qNT93S3UoYUkqAZ9lLg8a7g9rimsWmYGK8cVToA4/sF3RrshdyV3sAGMXVUmpMYOw+dLpOuw==
nice-try@^1.0.4:
version "1.0.5"
resolved "https://registry.yarnpkg.com/nice-try/-/nice-try-1.0.5.tgz#a3378a7696ce7d223e88fc9b764bd7ef1089e366"
@ -3580,6 +3602,11 @@ typescript@^4.0.3:
resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.0.3.tgz#153bbd468ef07725c1df9c77e8b453f8d36abba5"
integrity sha512-tEu6DGxGgRJPb/mVPIZ48e69xCn2yRmCgYmDugAVwmJ6o+0u1RI18eO7E7WBTLYLaEVVOhwQmcdhQHweux/WPg==
uglify-js@^3.1.4:
version "3.11.3"
resolved "https://registry.yarnpkg.com/uglify-js/-/uglify-js-3.11.3.tgz#b2f8c87826344f091ba48c417c499d6cba5d5786"
integrity sha512-wDRziHG94mNj2n3R864CvYw/+pc9y/RNImiTyrrf8BzgWn75JgFSwYvXrtZQMnMnOp/4UTrf3iCSQxSStPiByA==
union-value@^1.0.0:
version "1.0.1"
resolved "https://registry.yarnpkg.com/union-value/-/union-value-1.0.1.tgz#0b6fe7b835aecda61c6ea4d4f02c14221e109847"
@ -3732,6 +3759,11 @@ word-wrap@~1.2.3:
resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"
integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==
wordwrap@^1.0.0:
version "1.0.0"
resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb"
integrity sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=
wrap-ansi@^6.2.0:
version "6.2.0"
resolved "https://registry.yarnpkg.com/wrap-ansi/-/wrap-ansi-6.2.0.tgz#e9393ba07102e6c91a3b221478f0257cd2856e53"