actions/build-push-action
2
0
Fork 0
mirror of https://github.com/docker/build-push-action.git synced 2024-11-26 20:59:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #412 from crazy-max/metadata-file

Browse Source 
Add `metadata` output
This commit is contained in:
CrazyMax 2021-08-20 10:28:45 +02:00 committed by GitHub
commit b0b7751850
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 104 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -214,8 +214,9 @@ Following inputs can be used as `step.with` keys
Following outputs are available
| Name | Type | Description |
|---------------|---------|---------------------------------------|
|-------------------|---------|---------------------------------------|
| `digest` | String | Image content-addressable identifier also called a digest |
| `metadata` | JSON | Build result metadata |
## Troubleshooting

15
__tests__/buildx.test.ts
View File

@ -8,6 +8,10 @@ import * as context from '../src/context';
const tmpNameSync = path.join('/tmp/.docker-build-push-jest', '.tmpname-jest').split(path.sep).join(path.posix.sep);
const digest = 'sha256:bfb45ab72e46908183546477a08f8867fc40cebadd00af54b071b097aed127a9';
const metadata = `{
"containerimage.config.digest": "sha256:059b68a595b22564a1cbc167af369349fdc2ecc1f7bc092c2235cbf601a795fd",
"containerimage.digest": "sha256:b09b9482c72371486bb2c1d2c2a2633ed1d0b8389e12c8d52b9e052725c0c83c"
}`;
jest.spyOn(context, 'tmpDir').mockImplementation((): string => {
const tmpDir = path.join('/tmp/.docker-build-push-jest').split(path.sep).join(path.posix.sep);
@ -32,6 +36,17 @@ describe('getImageID', () => {
});
});
describe('getMetadata', () => {
it('matches', async () => {
const metadataFile = await buildx.getMetadataFile();
console.log(`metadataFile: ${metadataFile}`);
await fs.writeFileSync(metadataFile, metadata);
const expected = await buildx.getMetadata();
console.log(`metadata: ${expected}`);
expect(expected).toEqual(metadata);
});
});
describe('isLocalOrTarExporter', () => {
// prettier-ignore
test.each([

23
__tests__/context.test.ts
View File

@ -425,7 +425,30 @@ ccc`],
'--output', 'type=local,dest=./release-out',
'.'
]
],
[
'0.6.0',
new Map<string, string>([
['context', '.'],
['tag', 'localhost:5000/name/app:latest'],
['file', './test/Dockerfile'],
['network', 'host'],
['load', 'false'],
['no-cache', 'false'],
['push', 'true'],
['pull', 'false']
]),
[
'buildx',
'build',
'--iidfile', '/tmp/.docker-build-push-jest/iidfile',
'--metadata-file', '/tmp/.docker-build-push-jest/metadata-file',
'--file', './test/Dockerfile',
'--network', 'host',
'--push',
'.'
]
],
])(
'given %p with %p as inputs, returns %p',
async (buildxVersion: string, inputs: Map<string, any>, expected: Array<string>) => {

2
action.yml
View File

@ -79,6 +79,8 @@ inputs:
outputs:
digest:
description: 'Image content-addressable identifier also called a digest'
metadata:
description: 'Build result metadata'
runs:
using: 'node12'

32
dist/index.js generated vendored
View File

@ -38,7 +38,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", ({ value: true }));
exports.satisfies = exports.parseVersion = exports.getVersion = exports.isAvailable = exports.hasGitAuthToken = exports.isLocalOrTarExporter = exports.getSecret = exports.getSecretFile = exports.getSecretString = exports.getImageID = exports.getImageIDFile = void 0;
exports.satisfies = exports.parseVersion = exports.getVersion = exports.isAvailable = exports.hasGitAuthToken = exports.isLocalOrTarExporter = exports.getSecret = exports.getSecretFile = exports.getSecretString = exports.getMetadata = exports.getMetadataFile = exports.getImageID = exports.getImageIDFile = void 0;
const sync_1 = __importDefault(__nccwpck_require__(8750));
const fs_1 = __importDefault(__nccwpck_require__(5747));
const path_1 = __importDefault(__nccwpck_require__(5622));
@ -61,6 +61,22 @@ function getImageID() {
});
}
exports.getImageID = getImageID;
function getMetadataFile() {
return __awaiter(this, void 0, void 0, function* () {
return path_1.default.join(context.tmpDir(), 'metadata-file').split(path_1.default.sep).join(path_1.default.posix.sep);
});
}
exports.getMetadataFile = getMetadataFile;
function getMetadata() {
return __awaiter(this, void 0, void 0, function* () {
const metadataFile = yield getMetadataFile();
if (!fs_1.default.existsSync(metadataFile)) {
return undefined;
}
return fs_1.default.readFileSync(metadataFile, { encoding: 'utf-8' });
});
}
exports.getMetadata = getMetadata;
function getSecretString(kvp) {
return __awaiter(this, void 0, void 0, function* () {
return getSecret(kvp, false);
@ -311,6 +327,9 @@ function getBuildArgs(inputs, defaultContext, buildxVersion) {
if (!buildx.isLocalOrTarExporter(inputs.outputs) && (inputs.platforms.length == 0 || buildx.satisfies(buildxVersion, '>=0.4.2'))) {
args.push('--iidfile', yield buildx.getImageIDFile());
}
if (buildx.satisfies(buildxVersion, '>=0.6.0')) {
args.push('--metadata-file', yield buildx.getMetadataFile());
}
yield exports.asyncForEach(inputs.cacheFrom, (cacheFrom) => __awaiter(this, void 0, void 0, function* () {
args.push('--cache-from', cacheFrom);
}));
@ -476,13 +495,18 @@ function run() {
throw new Error(`buildx failed with: ${res.stderr.match(/(.*)\s*$/)[0].trim()}`);
}
});
yield core.group(`Setting outputs`, () => __awaiter(this, void 0, void 0, function* () {
const imageID = yield buildx.getImageID();
const metadata = yield buildx.getMetadata();
if (imageID) {
core.startGroup(`Extracting digest`);
core.info(`${imageID}`);
core.info(`digest=${imageID}`);
context.setOutput('digest', imageID);
core.endGroup();
}
if (metadata) {
core.info(`metadata=${metadata}`);
context.setOutput('metadata', metadata);
}
}));
}
catch (error) {
core.setFailed(error.message);

12
src/buildx.ts
View File

@ -18,6 +18,18 @@ export async function getImageID(): Promise<string | undefined> {
return fs.readFileSync(iidFile, {encoding: 'utf-8'});
}
export async function getMetadataFile(): Promise<string> {
return path.join(context.tmpDir(), 'metadata-file').split(path.sep).join(path.posix.sep);
}
export async function getMetadata(): Promise<string | undefined> {
const metadataFile = await getMetadataFile();
if (!fs.existsSync(metadataFile)) {
return undefined;
}
return fs.readFileSync(metadataFile, {encoding: 'utf-8'});
}
export async function getSecretString(kvp: string): Promise<string> {
return getSecret(kvp, false);
}

4
src/context.ts
View File

@ -2,7 +2,6 @@ import csvparse from 'csv-parse/lib/sync';
import * as fs from 'fs';
import * as os from 'os';
import * as path from 'path';
import * as semver from 'semver';
import * as tmp from 'tmp';
import * as core from '@actions/core';
@ -122,6 +121,9 @@ async function getBuildArgs(inputs: Inputs, defaultContext: string, buildxVersio
if (!buildx.isLocalOrTarExporter(inputs.outputs) && (inputs.platforms.length == 0 || buildx.satisfies(buildxVersion, '>=0.4.2'))) {
args.push('--iidfile', await buildx.getImageIDFile());
}
if (buildx.satisfies(buildxVersion, '>=0.6.0')) {
args.push('--metadata-file', await buildx.getMetadataFile());
}
await asyncForEach(inputs.cacheFrom, async cacheFrom => {
args.push('--cache-from', cacheFrom);
});

11
src/main.ts
View File

@ -33,13 +33,18 @@ async function run(): Promise<void> {
}
});
await core.group(`Setting outputs`, async () => {
const imageID = await buildx.getImageID();
const metadata = await buildx.getMetadata();
if (imageID) {
core.startGroup(`Extracting digest`);
core.info(`${imageID}`);
core.info(`digest=${imageID}`);
context.setOutput('digest', imageID);
core.endGroup();
}
if (metadata) {
core.info(`metadata=${metadata}`);
context.setOutput('metadata', metadata);
}
});
} catch (error) {
core.setFailed(error.message);
}