mirror of
https://github.com/docker/metadata-action.git
synced 2026-11-16 23:15:02 +08:00
Merge e7cd22ea3f into 8e671d84a3
This commit is contained in:
commit
4c2c3bbacb
7 changed files with 128 additions and 45 deletions
21
README.md
21
README.md
|
|
@ -46,6 +46,7 @@ ___
|
||||||
* [`{{is_default_branch}}`](#is_default_branch)
|
* [`{{is_default_branch}}`](#is_default_branch)
|
||||||
* [`{{is_not_default_branch}}`](#is_not_default_branch)
|
* [`{{is_not_default_branch}}`](#is_not_default_branch)
|
||||||
* [`{{date '<format>' tz='<timezone>'}}`](#date-format-tztimezone)
|
* [`{{date '<format>' tz='<timezone>'}}`](#date-format-tztimezone)
|
||||||
|
* [`{{commit_count}}`](#commit_count)
|
||||||
* [`{{commit_date '<format>' tz='<timezone>'}}`](#commit_date-format-tztimezone)
|
* [`{{commit_date '<format>' tz='<timezone>'}}`](#commit_date-format-tztimezone)
|
||||||
* [Major version zero](#major-version-zero)
|
* [Major version zero](#major-version-zero)
|
||||||
* [JSON output object](#json-output-object)
|
* [JSON output object](#json-output-object)
|
||||||
|
|
@ -908,6 +909,26 @@ Default `tz` is UTC.
|
||||||
| `{{date 'dddd, MMMM Do YYYY, h:mm:ss a'}}` | `Friday, January 10th 2020, 3:25:50 pm` |
|
| `{{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` |
|
| `{{date 'YYYYMMDD-HHmmss' tz='Asia/Tokyo'}}` | `20200110-093000` |
|
||||||
|
|
||||||
|
#### `{{commit_count}}`
|
||||||
|
|
||||||
|
Returns the number of commits reachable from `HEAD` in the selected Git checkout,
|
||||||
|
using `git rev-list --count HEAD`. Requires `context: git` or `context: git:<path>`;
|
||||||
|
using this expression with workflow context produces an error.
|
||||||
|
|
||||||
|
Shallow checkouts count only the available history. Use `fetch-depth: 0` to fetch
|
||||||
|
the full history when you need the complete count:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
- uses: actions/checkout@v7
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- uses: docker/metadata-action@v6
|
||||||
|
with:
|
||||||
|
context: git
|
||||||
|
images: name/app
|
||||||
|
tags: type=raw,value=rev-{{commit_count}}
|
||||||
|
```
|
||||||
|
|
||||||
#### `{{commit_date '<format>' tz='<timezone>'}}`
|
#### `{{commit_date '<format>' tz='<timezone>'}}`
|
||||||
|
|
||||||
Returns the date when the current git commit is committed, rendered by its
|
Returns the date when the current git commit is committed, rendered by its
|
||||||
|
|
|
||||||
|
|
@ -169,12 +169,15 @@ describe('getContext', () => {
|
||||||
it('workflow does not read Git context', async () => {
|
it('workflow does not read Git context', async () => {
|
||||||
const gitContext = vi.spyOn(Git, 'context');
|
const gitContext = vi.spyOn(Git, 'context');
|
||||||
const gitCommitDate = vi.spyOn(Git, 'commitDate');
|
const gitCommitDate = vi.spyOn(Git, 'commitDate');
|
||||||
|
const gitCommitCount = vi.spyOn(Git, 'commitCount');
|
||||||
const ctx = await context.getContext(context.ContextSource.workflow, toolkit);
|
const ctx = await context.getContext(context.ContextSource.workflow, toolkit);
|
||||||
expect(ctx.ref).toEqual('refs/heads/dev');
|
expect(ctx.ref).toEqual('refs/heads/dev');
|
||||||
expect(ctx.sha).toEqual('5f3331d7f7044c18ca9f12c77d961c4d7cf3276a');
|
expect(ctx.sha).toEqual('5f3331d7f7044c18ca9f12c77d961c4d7cf3276a');
|
||||||
expect(ctx.commitDate).toEqual(new Date('2024-11-13T13:42:28.000Z'));
|
expect(ctx.commitDate).toEqual(new Date('2024-11-13T13:42:28.000Z'));
|
||||||
expect(gitContext).not.toHaveBeenCalled();
|
expect(gitContext).not.toHaveBeenCalled();
|
||||||
expect(gitCommitDate).not.toHaveBeenCalled();
|
expect(gitCommitDate).not.toHaveBeenCalled();
|
||||||
|
expect(gitCommitCount).not.toHaveBeenCalled();
|
||||||
|
expect(ctx.commitCount).toBeUndefined();
|
||||||
});
|
});
|
||||||
it.each<[string, string | undefined]>([
|
it.each<[string, string | undefined]>([
|
||||||
['git', undefined],
|
['git', undefined],
|
||||||
|
|
@ -191,9 +194,12 @@ describe('getContext', () => {
|
||||||
vi.spyOn(Git, 'commitDate').mockImplementation(async (): Promise<Date> => {
|
vi.spyOn(Git, 'commitDate').mockImplementation(async (): Promise<Date> => {
|
||||||
return new Date('2023-01-01T13:42:28.000Z');
|
return new Date('2023-01-01T13:42:28.000Z');
|
||||||
});
|
});
|
||||||
|
vi.spyOn(Git, 'commitCount').mockResolvedValue(42);
|
||||||
const ctx = await context.getContext(source, toolkit);
|
const ctx = await context.getContext(source, toolkit);
|
||||||
expect(Git.context).toHaveBeenCalledWith(workdir);
|
expect(Git.context).toHaveBeenCalledWith(workdir);
|
||||||
expect(Git.commitDate).toHaveBeenCalledWith('git-test-sha', workdir);
|
expect(Git.commitDate).toHaveBeenCalledWith('git-test-sha', workdir);
|
||||||
|
expect(Git.commitCount).toHaveBeenCalledWith(workdir);
|
||||||
|
expect(ctx.commitCount).toEqual(42);
|
||||||
expect(ctx.ref).toEqual('refs/heads/git-test');
|
expect(ctx.ref).toEqual('refs/heads/git-test');
|
||||||
expect(ctx.sha).toEqual('git-test-sha');
|
expect(ctx.sha).toEqual('git-test-sha');
|
||||||
expect(ctx.commitDate).toEqual(new Date('2023-01-01T13:42:28.000Z'));
|
expect(ctx.commitDate).toEqual(new Date('2023-01-01T13:42:28.000Z'));
|
||||||
|
|
@ -218,11 +224,13 @@ describe('getContext', () => {
|
||||||
try {
|
try {
|
||||||
git(['init', '--initial-branch=selected-checkout']);
|
git(['init', '--initial-branch=selected-checkout']);
|
||||||
git(['-c', 'user.name=Test', '-c', 'user.email=test@example.com', '-c', 'commit.gpgsign=false', 'commit', '--allow-empty', '-m', 'initial']);
|
git(['-c', 'user.name=Test', '-c', 'user.email=test@example.com', '-c', 'commit.gpgsign=false', 'commit', '--allow-empty', '-m', 'initial']);
|
||||||
|
git(['-c', 'user.name=Test', '-c', 'user.email=test@example.com', '-c', 'commit.gpgsign=false', 'commit', '--allow-empty', '-m', 'second']);
|
||||||
const sha = git(['rev-parse', 'HEAD']);
|
const sha = git(['rev-parse', 'HEAD']);
|
||||||
const ctx = await context.getContext(`git:${workdir}`, toolkit);
|
const ctx = await context.getContext(`git:${workdir}`, toolkit);
|
||||||
expect(ctx.ref).toEqual('refs/heads/selected-checkout');
|
expect(ctx.ref).toEqual('refs/heads/selected-checkout');
|
||||||
expect(ctx.sha).toEqual(sha);
|
expect(ctx.sha).toEqual(sha);
|
||||||
expect(ctx.commitDate).toEqual(new Date(commitDate));
|
expect(ctx.commitDate).toEqual(new Date(commitDate));
|
||||||
|
expect(ctx.commitCount).toEqual(2);
|
||||||
|
|
||||||
git(['checkout', '--detach', 'HEAD']);
|
git(['checkout', '--detach', 'HEAD']);
|
||||||
git(['branch', '-D', 'selected-checkout']);
|
git(['branch', '-D', 'selected-checkout']);
|
||||||
|
|
@ -230,8 +238,18 @@ describe('getContext', () => {
|
||||||
expect(detachedContext.ref).toEqual('');
|
expect(detachedContext.ref).toEqual('');
|
||||||
expect(detachedContext.sha).toEqual(sha);
|
expect(detachedContext.sha).toEqual(sha);
|
||||||
expect(detachedContext.commitDate).toEqual(new Date(commitDate));
|
expect(detachedContext.commitDate).toEqual(new Date(commitDate));
|
||||||
|
expect(detachedContext.commitCount).toEqual(2);
|
||||||
const meta = new Meta({...context.getInputs(), images: ['name/app'], tags: ['type=sha,format=long'], flavor: []}, detachedContext, repoFixture);
|
const meta = new Meta({...context.getInputs(), images: ['name/app'], tags: ['type=sha,format=long'], flavor: []}, detachedContext, repoFixture);
|
||||||
expect(meta.getTags()).toEqual([`name/app:sha-${sha}`]);
|
expect(meta.getTags()).toEqual([`name/app:sha-${sha}`]);
|
||||||
|
|
||||||
|
const shallowDir = path.join(checkoutDir, 'shallow');
|
||||||
|
git(['init', shallowDir]);
|
||||||
|
git(['-C', shallowDir, 'fetch', '--depth=1', '--no-tags', checkoutDir, sha]);
|
||||||
|
git(['-C', shallowDir, 'checkout', '--detach', 'FETCH_HEAD']);
|
||||||
|
const shallowContext = await context.getContext(`git:${shallowDir}`, toolkit);
|
||||||
|
expect(shallowContext.commitCount).toEqual(1);
|
||||||
|
const shallowMeta = new Meta({...context.getInputs(), images: ['name/app'], tags: ['type=raw,value=rev-{{commit_count}}'], flavor: []}, shallowContext, repoFixture);
|
||||||
|
expect(shallowMeta.getTags()).toEqual(['name/app:rev-1']);
|
||||||
} finally {
|
} finally {
|
||||||
fs.rmSync(checkoutDir, {recursive: true, force: true});
|
fs.rmSync(checkoutDir, {recursive: true, force: true});
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -63,6 +63,42 @@ beforeEach(() => {
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
describe('commit_count', () => {
|
||||||
|
test('expands the count in tags, flavor, labels, and annotations', async () => {
|
||||||
|
const toolkit = new Toolkit({githubToken: 'fake-github-token'});
|
||||||
|
const context = await getContext(ContextSource.workflow, toolkit);
|
||||||
|
context.commitCount = 42;
|
||||||
|
const meta = new Meta(
|
||||||
|
{
|
||||||
|
...getInputs(),
|
||||||
|
images: ['name/app'],
|
||||||
|
tags: ['type=raw,value=rev-{{commit_count}}'],
|
||||||
|
flavor: ['suffix=-{{commit_count}}'],
|
||||||
|
labels: ['com.example.commit-count={{commit_count}}'],
|
||||||
|
annotations: ['com.example.commit-count={{commit_count}}']
|
||||||
|
},
|
||||||
|
context,
|
||||||
|
await toolkit.github.repoData()
|
||||||
|
);
|
||||||
|
expect(meta.getTags()).toEqual(['name/app:rev-42-42']);
|
||||||
|
expect(meta.getLabels()).toContain('com.example.commit-count=42');
|
||||||
|
expect(meta.getAnnotations()).toContain('com.example.commit-count=42');
|
||||||
|
});
|
||||||
|
|
||||||
|
test.each(['tags', 'labels', 'annotations'])('rejects commit_count in %s with workflow context', async input => {
|
||||||
|
const toolkit = new Toolkit({githubToken: 'fake-github-token'});
|
||||||
|
const context = await getContext(ContextSource.workflow, toolkit);
|
||||||
|
const inputs = {...getInputs(), images: ['name/app'], tags: ['type=raw,value=test'], labels: [], annotations: [], flavor: []};
|
||||||
|
inputs[input] = [input === 'tags' ? 'type=raw,value={{commit_count}}' : 'com.example.commit-count={{commit_count}}'];
|
||||||
|
const repo = await toolkit.github.repoData();
|
||||||
|
expect(() => {
|
||||||
|
const meta = new Meta(inputs, context, repo);
|
||||||
|
meta.getLabels();
|
||||||
|
meta.getAnnotations();
|
||||||
|
}).toThrow('The commit_count expression requires Git context (context: git or git:<path>)');
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
describe('isRawStatement', () => {
|
describe('isRawStatement', () => {
|
||||||
// prettier-ignore
|
// prettier-ignore
|
||||||
test.each([
|
test.each([
|
||||||
|
|
|
||||||
86
dist/index.cjs
generated
vendored
86
dist/index.cjs
generated
vendored
File diff suppressed because one or more lines are too long
4
dist/index.cjs.map
generated
vendored
4
dist/index.cjs.map
generated
vendored
File diff suppressed because one or more lines are too long
|
|
@ -9,6 +9,7 @@ type GithubContext = typeof GitHub.context;
|
||||||
|
|
||||||
export interface Context extends GithubContext {
|
export interface Context extends GithubContext {
|
||||||
commitDate: Date;
|
commitDate: Date;
|
||||||
|
commitCount?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface Inputs {
|
export interface Inputs {
|
||||||
|
|
@ -90,6 +91,7 @@ async function getContextFromGit(workdir?: string): Promise<Context> {
|
||||||
|
|
||||||
return {
|
return {
|
||||||
commitDate: await Git.commitDate(ctx.sha, workdir),
|
commitDate: await Git.commitDate(ctx.sha, workdir),
|
||||||
|
commitCount: await Git.commitCount(workdir),
|
||||||
...ctx
|
...ctx
|
||||||
} as Context;
|
} as Context;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -416,6 +416,12 @@ export class Meta {
|
||||||
sha: function () {
|
sha: function () {
|
||||||
return Meta.shortSha(context.sha);
|
return Meta.shortSha(context.sha);
|
||||||
},
|
},
|
||||||
|
commit_count: function () {
|
||||||
|
if (context.commitCount === undefined) {
|
||||||
|
throw new Error('The commit_count expression requires Git context (context: git or git:<path>)');
|
||||||
|
}
|
||||||
|
return context.commitCount;
|
||||||
|
},
|
||||||
base_ref: function () {
|
base_ref: function () {
|
||||||
if (/^refs\/tags\//.test(context.ref) && context.payload?.base_ref != undefined) {
|
if (/^refs\/tags\//.test(context.ref) && context.payload?.base_ref != undefined) {
|
||||||
return context.payload.base_ref.replace(/^refs\/heads\//g, '');
|
return context.payload.base_ref.replace(/^refs\/heads\//g, '');
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue