From a2d6fee37e9c071cd04d1da8d19eebb5048def87 Mon Sep 17 00:00:00 2001 From: Brian DeHamer Date: Thu, 21 Nov 2024 12:53:27 -0800 Subject: [PATCH] readme updates for v2 release (#173) Signed-off-by: Brian DeHamer --- README.md | 12 ++++++------ __tests__/main.test.ts | 4 ++-- action.yml | 4 ++-- dist/index.js | 2 +- src/main.ts | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b772f5d8..daaaf28d 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ See [action.yml](action.yml) with: # Path to the artifact serving as the subject of the attestation. Must # specify exactly one of "subject-path" or "subject-digest". May contain - # a glob pattern or list of paths (total subject count cannot exceed 2500). + # a glob pattern or list of paths (total subject count cannot exceed 1024). subject-path: # SHA256 digest of the subject for the attestation. Must be in the form @@ -109,9 +109,9 @@ See [action.yml](action.yml) -| Name | Description | Example | -| ------------- | -------------------------------------------------------------- | ------------------------ | -| `bundle-path` | Absolute path to the file containing the generated attestation | `/tmp/attestation.jsonl` | +| Name | Description | Example | +| ------------- | -------------------------------------------------------------- | ----------------------- | +| `bundle-path` | Absolute path to the file containing the generated attestation | `/tmp/attestation.json` | @@ -166,8 +166,8 @@ jobs: ### Identify Multiple Subjects -If you are generating multiple artifacts, you can generate an attestation for -each by using a wildcard in the `subject-path` input. +If you are generating multiple artifacts, you can attest all of them at the same +time by using a wildcard in the `subject-path` input. ```yaml - uses: actions/attest@v1 diff --git a/__tests__/main.test.ts b/__tests__/main.test.ts index ef4a18e8..f809d441 100644 --- a/__tests__/main.test.ts +++ b/__tests__/main.test.ts @@ -197,7 +197,7 @@ describe('action', () => { expect(setOutputMock).toHaveBeenNthCalledWith( 1, 'bundle-path', - expect.stringMatching('attestation.jsonl') + expect.stringMatching('attestation.json') ) expect(setFailedMock).not.toHaveBeenCalled() }) @@ -283,7 +283,7 @@ describe('action', () => { expect(setOutputMock).toHaveBeenNthCalledWith( 1, 'bundle-path', - expect.stringMatching('attestation.jsonl') + expect.stringMatching('attestation.json') ) expect(setFailedMock).not.toHaveBeenCalled() }) diff --git a/action.yml b/action.yml index 423e877d..e24451e7 100644 --- a/action.yml +++ b/action.yml @@ -10,7 +10,7 @@ inputs: description: > Path to the artifact serving as the subject of the attestation. Must specify exactly one of "subject-path" or "subject-digest". May contain a - glob pattern or list of paths (total subject count cannot exceed 2500). + glob pattern or list of paths (total subject count cannot exceed 1024). required: false subject-digest: description: > @@ -60,7 +60,7 @@ inputs: required: false outputs: bundle-path: - description: 'The path to the file containing the attestation bundle(s).' + description: 'The path to the file containing the attestation bundle.' runs: using: node20 diff --git a/dist/index.js b/dist/index.js index b2a4c0f5..5142c5f0 100644 --- a/dist/index.js +++ b/dist/index.js @@ -70907,7 +70907,7 @@ const endpoints_1 = __nccwpck_require__(7437); const predicate_1 = __nccwpck_require__(84982); const style = __importStar(__nccwpck_require__(64542)); const subject_1 = __nccwpck_require__(36303); -const ATTESTATION_FILE_NAME = 'attestation.jsonl'; +const ATTESTATION_FILE_NAME = 'attestation.json'; /* istanbul ignore next */ const logHandler = (level, ...args) => { // Send any HTTP-related log events to the GitHub Actions debug log diff --git a/src/main.ts b/src/main.ts index a5bbecc1..b77839fe 100644 --- a/src/main.ts +++ b/src/main.ts @@ -15,7 +15,7 @@ import { import type { Subject } from '@actions/attest' -const ATTESTATION_FILE_NAME = 'attestation.jsonl' +const ATTESTATION_FILE_NAME = 'attestation.json' export type RunInputs = SubjectInputs & PredicateInputs & {