actions/attest
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme updates for v2 release (#173)

Browse Source 
Signed-off-by: Brian DeHamer <bdehamer@github.com>
This commit is contained in:
Brian DeHamer
2024-11-21 12:53:27 -08:00
committed by GitHub
parent 9f6c991ce4
commit a2d6fee37e
5 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -65,7 +65,7 @@ See [action.yml](action.yml)
with: with:
# Path to the artifact serving as the subject of the attestation. Must # Path to the artifact serving as the subject of the attestation. Must
# specify exactly one of "subject-path" or "subject-digest". May contain # 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: subject-path:
# SHA256 digest of the subject for the attestation. Must be in the form # SHA256 digest of the subject for the attestation. Must be in the form
@@ -109,9 +109,9 @@ See [action.yml](action.yml)
<!-- markdownlint-disable MD013 --> <!-- markdownlint-disable MD013 -->
| Name | Description | Example | | Name | Description | Example |
| ------------- | -------------------------------------------------------------- | ------------------------ | | ------------- | -------------------------------------------------------------- | ----------------------- |
| `bundle-path` | Absolute path to the file containing the generated attestation | `/tmp/attestation.jsonl` | | `bundle-path` | Absolute path to the file containing the generated attestation | `/tmp/attestation.json` |
<!-- markdownlint-enable MD013 --> <!-- markdownlint-enable MD013 -->
@@ -166,8 +166,8 @@ jobs:
### Identify Multiple Subjects ### Identify Multiple Subjects
If you are generating multiple artifacts, you can generate an attestation for If you are generating multiple artifacts, you can attest all of them at the same
each by using a wildcard in the `subject-path` input. time by using a wildcard in the `subject-path` input.
```yaml ```yaml
- uses: actions/attest@v1 - uses: actions/attest@v1

4
__tests__/main.test.ts
View File

@@ -197,7 +197,7 @@ describe('action', () => {
expect(setOutputMock).toHaveBeenNthCalledWith( expect(setOutputMock).toHaveBeenNthCalledWith(
1, 1,
'bundle-path', 'bundle-path',
expect.stringMatching('attestation.jsonl') expect.stringMatching('attestation.json')
) )
expect(setFailedMock).not.toHaveBeenCalled() expect(setFailedMock).not.toHaveBeenCalled()
}) })
@@ -283,7 +283,7 @@ describe('action', () => {
expect(setOutputMock).toHaveBeenNthCalledWith( expect(setOutputMock).toHaveBeenNthCalledWith(
1, 1,
'bundle-path', 'bundle-path',
expect.stringMatching('attestation.jsonl') expect.stringMatching('attestation.json')
) )
expect(setFailedMock).not.toHaveBeenCalled() expect(setFailedMock).not.toHaveBeenCalled()
}) })

4
action.yml
View File

@@ -10,7 +10,7 @@ inputs:
description: > description: >
Path to the artifact serving as the subject of the attestation. Must Path to the artifact serving as the subject of the attestation. Must
specify exactly one of "subject-path" or "subject-digest". May contain a 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 required: false
subject-digest: subject-digest:
description: > description: >
@@ -60,7 +60,7 @@ inputs:
required: false required: false
outputs: outputs:
bundle-path: bundle-path:
description: 'The path to the file containing the attestation bundle(s).' description: 'The path to the file containing the attestation bundle.'
runs: runs:
using: node20 using: node20

2
dist/index.js generated vendored
View File

@@ -70907,7 +70907,7 @@ const endpoints_1 = __nccwpck_require__(7437);
const predicate_1 = __nccwpck_require__(84982); const predicate_1 = __nccwpck_require__(84982);
const style = __importStar(__nccwpck_require__(64542)); const style = __importStar(__nccwpck_require__(64542));
const subject_1 = __nccwpck_require__(36303); const subject_1 = __nccwpck_require__(36303);
const ATTESTATION_FILE_NAME = 'attestation.jsonl'; const ATTESTATION_FILE_NAME = 'attestation.json';
/* istanbul ignore next */ /* istanbul ignore next */
const logHandler = (level, ...args) => { const logHandler = (level, ...args) => {
// Send any HTTP-related log events to the GitHub Actions debug log // Send any HTTP-related log events to the GitHub Actions debug log

2
src/main.ts
View File

@@ -15,7 +15,7 @@ import {
import type { Subject } from '@actions/attest' import type { Subject } from '@actions/attest'
const ATTESTATION_FILE_NAME = 'attestation.jsonl' const ATTESTATION_FILE_NAME = 'attestation.json'
export type RunInputs = SubjectInputs & export type RunInputs = SubjectInputs &
PredicateInputs & { PredicateInputs & {