Compare commits
1
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
504abd5cd2 |
@@ -0,0 +1,4 @@
|
|||||||
|
lib/
|
||||||
|
dist/
|
||||||
|
node_modules/
|
||||||
|
coverage/
|
||||||
@@ -0,0 +1,83 @@
|
|||||||
|
env:
|
||||||
|
node: true
|
||||||
|
es6: true
|
||||||
|
jest: true
|
||||||
|
|
||||||
|
globals:
|
||||||
|
Atomics: readonly
|
||||||
|
SharedArrayBuffer: readonly
|
||||||
|
|
||||||
|
ignorePatterns:
|
||||||
|
- '!.*'
|
||||||
|
- '**/node_modules/.*'
|
||||||
|
- '**/dist/.*'
|
||||||
|
- '**/coverage/.*'
|
||||||
|
- '*.json'
|
||||||
|
|
||||||
|
parser: '@typescript-eslint/parser'
|
||||||
|
|
||||||
|
parserOptions:
|
||||||
|
ecmaVersion: 2023
|
||||||
|
sourceType: module
|
||||||
|
project:
|
||||||
|
- './.github/linters/tsconfig.json'
|
||||||
|
- './tsconfig.json'
|
||||||
|
|
||||||
|
plugins:
|
||||||
|
- jest
|
||||||
|
- '@typescript-eslint'
|
||||||
|
|
||||||
|
extends:
|
||||||
|
- eslint:recommended
|
||||||
|
- plugin:@typescript-eslint/eslint-recommended
|
||||||
|
- plugin:@typescript-eslint/recommended
|
||||||
|
- plugin:github/recommended
|
||||||
|
- plugin:jest/recommended
|
||||||
|
|
||||||
|
rules:
|
||||||
|
{
|
||||||
|
'camelcase': 'off',
|
||||||
|
'eslint-comments/no-use': 'off',
|
||||||
|
'eslint-comments/no-unused-disable': 'off',
|
||||||
|
'i18n-text/no-en': 'off',
|
||||||
|
'import/no-namespace': 'off',
|
||||||
|
'no-console': 'off',
|
||||||
|
'no-unused-vars': 'off',
|
||||||
|
'prettier/prettier': 'error',
|
||||||
|
'semi': 'off',
|
||||||
|
'@typescript-eslint/array-type': 'error',
|
||||||
|
'@typescript-eslint/await-thenable': 'error',
|
||||||
|
'@typescript-eslint/ban-ts-comment': 'error',
|
||||||
|
'@typescript-eslint/consistent-type-assertions': 'error',
|
||||||
|
'@typescript-eslint/explicit-member-accessibility':
|
||||||
|
['error', { 'accessibility': 'no-public' }],
|
||||||
|
'@typescript-eslint/explicit-function-return-type':
|
||||||
|
['error', { 'allowExpressions': true }],
|
||||||
|
'@typescript-eslint/func-call-spacing': ['error', 'never'],
|
||||||
|
'@typescript-eslint/no-array-constructor': 'error',
|
||||||
|
'@typescript-eslint/no-empty-interface': 'error',
|
||||||
|
'@typescript-eslint/no-explicit-any': 'error',
|
||||||
|
'@typescript-eslint/no-extraneous-class': 'error',
|
||||||
|
'@typescript-eslint/no-for-in-array': 'error',
|
||||||
|
'@typescript-eslint/no-inferrable-types': 'error',
|
||||||
|
'@typescript-eslint/no-misused-new': 'error',
|
||||||
|
'@typescript-eslint/no-namespace': 'error',
|
||||||
|
'@typescript-eslint/no-non-null-assertion': 'warn',
|
||||||
|
'@typescript-eslint/no-require-imports': 'error',
|
||||||
|
'@typescript-eslint/no-unnecessary-qualifier': 'error',
|
||||||
|
'@typescript-eslint/no-unnecessary-type-assertion': 'error',
|
||||||
|
'@typescript-eslint/no-unused-vars': 'error',
|
||||||
|
'@typescript-eslint/no-useless-constructor': 'error',
|
||||||
|
'@typescript-eslint/no-var-requires': 'error',
|
||||||
|
'@typescript-eslint/prefer-for-of': 'warn',
|
||||||
|
'@typescript-eslint/prefer-function-type': 'warn',
|
||||||
|
'@typescript-eslint/prefer-includes': 'error',
|
||||||
|
'@typescript-eslint/prefer-string-starts-ends-with': 'error',
|
||||||
|
'@typescript-eslint/promise-function-async': 'error',
|
||||||
|
'@typescript-eslint/require-array-sort-compare': 'error',
|
||||||
|
'@typescript-eslint/restrict-plus-operands': 'error',
|
||||||
|
'@typescript-eslint/semi': ['error', 'never'],
|
||||||
|
'@typescript-eslint/space-before-function-paren': 'off',
|
||||||
|
'@typescript-eslint/type-annotation-spacing': 'error',
|
||||||
|
'@typescript-eslint/unbound-method': 'error'
|
||||||
|
}
|
||||||
@@ -0,0 +1,10 @@
|
|||||||
|
rules:
|
||||||
|
document-end: disable
|
||||||
|
document-start:
|
||||||
|
level: warning
|
||||||
|
present: false
|
||||||
|
line-length:
|
||||||
|
level: warning
|
||||||
|
max: 80
|
||||||
|
allow-non-breakable-words: true
|
||||||
|
allow-non-breakable-inline-mappings: true
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://json.schemastore.org/tsconfig",
|
||||||
|
"extends": "../../tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"noEmit": true
|
||||||
|
},
|
||||||
|
"include": ["../../__tests__/**/*", "../../src/**/*"],
|
||||||
|
"exclude": ["../../dist", "../../node_modules", "../../coverage", "*.json"]
|
||||||
|
}
|
||||||
@@ -28,11 +28,11 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
id: checkout
|
id: checkout
|
||||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
id: setup-node
|
id: setup-node
|
||||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
uses: actions/setup-node@v4
|
||||||
with:
|
with:
|
||||||
node-version-file: .node-version
|
node-version-file: .node-version
|
||||||
cache: npm
|
cache: npm
|
||||||
|
|||||||
@@ -21,11 +21,11 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
id: checkout
|
id: checkout
|
||||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||||
|
|
||||||
- name: Setup Node.js
|
- name: Setup Node.js
|
||||||
id: setup-node
|
id: setup-node
|
||||||
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
|
uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1
|
||||||
with:
|
with:
|
||||||
node-version-file: .node-version
|
node-version-file: .node-version
|
||||||
cache: npm
|
cache: npm
|
||||||
@@ -57,7 +57,7 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
id: checkout
|
id: checkout
|
||||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
||||||
- name: Run attest-provenance
|
- name: Run attest-provenance
|
||||||
id: attest-provenance
|
id: attest-provenance
|
||||||
uses: ./
|
uses: ./
|
||||||
|
|||||||
@@ -32,19 +32,19 @@ jobs:
|
|||||||
steps:
|
steps:
|
||||||
- name: Checkout
|
- name: Checkout
|
||||||
id: checkout
|
id: checkout
|
||||||
uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
|
uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Initialize CodeQL
|
- name: Initialize CodeQL
|
||||||
id: initialize
|
id: initialize
|
||||||
uses: github/codeql-action/init@df559355d593797519d70b90fc8edd5db049e7a2 # v3.29.9
|
uses: github/codeql-action/init@v3
|
||||||
with:
|
with:
|
||||||
languages: ${{ matrix.language }}
|
languages: ${{ matrix.language }}
|
||||||
source-root: src
|
source-root: src
|
||||||
|
|
||||||
- name: Autobuild
|
- name: Autobuild
|
||||||
id: autobuild
|
id: autobuild
|
||||||
uses: github/codeql-action/autobuild@df559355d593797519d70b90fc8edd5db049e7a2 # v3.29.9
|
uses: github/codeql-action/autobuild@v3
|
||||||
|
|
||||||
- name: Perform CodeQL Analysis
|
- name: Perform CodeQL Analysis
|
||||||
id: analyze
|
id: analyze
|
||||||
uses: github/codeql-action/analyze@df559355d593797519d70b90fc8edd5db049e7a2 # v3.29.9
|
uses: github/codeql-action/analyze@v3
|
||||||
|
|||||||
@@ -0,0 +1,51 @@
|
|||||||
|
name: Lint Codebase
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
packages: read
|
||||||
|
statuses: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
lint:
|
||||||
|
name: Lint Codebase
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checkout
|
||||||
|
id: checkout
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Setup Node.js
|
||||||
|
id: setup-node
|
||||||
|
uses: actions/setup-node@v4
|
||||||
|
with:
|
||||||
|
node-version-file: .node-version
|
||||||
|
cache: npm
|
||||||
|
|
||||||
|
- name: Install Dependencies
|
||||||
|
id: install
|
||||||
|
run: npm ci
|
||||||
|
|
||||||
|
- name: Lint Codebase
|
||||||
|
id: super-linter
|
||||||
|
uses: super-linter/super-linter/slim@v7
|
||||||
|
env:
|
||||||
|
DEFAULT_BRANCH: main
|
||||||
|
FILTER_REGEX_EXCLUDE: dist/**/*
|
||||||
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
TYPESCRIPT_DEFAULT_STYLE: prettier
|
||||||
|
VALIDATE_ALL_CODEBASE: true
|
||||||
|
VALIDATE_JAVASCRIPT_STANDARD: false
|
||||||
|
VALIDATE_TYPESCRIPT_STANDARD: false
|
||||||
|
VALIDATE_JSCPD: false
|
||||||
|
VALIDATE_YAML_PRETTIER: false
|
||||||
@@ -29,7 +29,7 @@ jobs:
|
|||||||
date > artifact
|
date > artifact
|
||||||
|
|
||||||
- name: Attest build provenance
|
- name: Attest build provenance
|
||||||
uses: actions/attest-build-provenance@v2
|
uses: actions/attest-build-provenance@v1
|
||||||
env:
|
env:
|
||||||
INPUT_PRIVATE-SIGNING: ${{ inputs.sigstore == 'github' && 'true' || 'false' }}
|
INPUT_PRIVATE-SIGNING: ${{ inputs.sigstore == 'github' && 'true' || 'false' }}
|
||||||
with:
|
with:
|
||||||
@@ -42,13 +42,13 @@ jobs:
|
|||||||
gh attestation verify ./artifact --owner "$GITHUB_REPOSITORY_OWNER"
|
gh attestation verify ./artifact --owner "$GITHUB_REPOSITORY_OWNER"
|
||||||
|
|
||||||
- name: Upload build artifact
|
- name: Upload build artifact
|
||||||
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
|
uses: actions/upload-artifact@v4
|
||||||
with:
|
with:
|
||||||
path: "artifact"
|
path: "artifact"
|
||||||
|
|
||||||
- name: Report attestation prober success
|
- name: Report attestation prober success
|
||||||
if: ${{ success() }}
|
if: ${{ success() }}
|
||||||
uses: masci/datadog@f0cad7cba58a34e65535732564c9bf174ee89006 # v1.9.2
|
uses: masci/datadog@a5d283e78e33a688ed08a96ba64440505e645a8c # v1.7.1
|
||||||
with:
|
with:
|
||||||
api-key: "${{ secrets.DATADOG_API_KEY }}"
|
api-key: "${{ secrets.DATADOG_API_KEY }}"
|
||||||
service-checks: |
|
service-checks: |
|
||||||
@@ -66,7 +66,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Report attestation prober failure
|
- name: Report attestation prober failure
|
||||||
if: ${{ failure() }}
|
if: ${{ failure() }}
|
||||||
uses: masci/datadog@f0cad7cba58a34e65535732564c9bf174ee89006 # v1.9.2
|
uses: masci/datadog@a5d283e78e33a688ed08a96ba64440505e645a8c # v1.7.1
|
||||||
with:
|
with:
|
||||||
api-key: "${{ secrets.DATADOG_API_KEY }}"
|
api-key: "${{ secrets.DATADOG_API_KEY }}"
|
||||||
service-checks: |
|
service-checks: |
|
||||||
|
|||||||
@@ -0,0 +1,22 @@
|
|||||||
|
name: 'Publish Immutable Action Version'
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [published]
|
||||||
|
|
||||||
|
permissions: {}
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
publish:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
id-token: write
|
||||||
|
packages: write
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- name: Checking out
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Publish
|
||||||
|
id: publish
|
||||||
|
uses: actions/[email protected]
|
||||||
+1
-1
@@ -1 +1 @@
|
|||||||
24.5.0
|
20.6.0
|
||||||
|
|||||||
@@ -25,16 +25,6 @@ CLI][5].
|
|||||||
See [Using artifact attestations to establish provenance for builds][9] for more
|
See [Using artifact attestations to establish provenance for builds][9] for more
|
||||||
information on artifact attestations.
|
information on artifact attestations.
|
||||||
|
|
||||||
<!-- prettier-ignore-start -->
|
|
||||||
> [!NOTE]
|
|
||||||
> Artifact attestations are available in public repositories for all
|
|
||||||
> current GitHub plans. They are not available on legacy plans, such as Bronze,
|
|
||||||
> Silver, or Gold. If you are on a GitHub Free, GitHub Pro, or GitHub Team plan,
|
|
||||||
> artifact attestations are only available for public repositories. To use
|
|
||||||
> artifact attestations in private or internal repositories, you must be on a
|
|
||||||
> GitHub Enterprise Cloud plan.
|
|
||||||
<!-- prettier-ignore-end -->
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Within the GitHub Actions workflow which builds some artifact you would like to
|
Within the GitHub Actions workflow which builds some artifact you would like to
|
||||||
@@ -55,7 +45,7 @@ attest:
|
|||||||
1. Add the following to your workflow after your artifact has been built:
|
1. Add the following to your workflow after your artifact has been built:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-build-provenance@v2
|
- uses: actions/attest-build-provenance@v1
|
||||||
with:
|
with:
|
||||||
subject-path: '<PATH TO ARTIFACT>'
|
subject-path: '<PATH TO ARTIFACT>'
|
||||||
```
|
```
|
||||||
@@ -68,28 +58,23 @@ attest:
|
|||||||
See [action.yml](action.yml)
|
See [action.yml](action.yml)
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-build-provenance@v2
|
- uses: actions/attest-build-provenance@v1
|
||||||
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", "subject-digest", or
|
# specify exactly one of "subject-path" or "subject-digest". May contain a
|
||||||
# "subject-checksums". May contain a glob pattern or list of paths
|
# glob pattern or list of paths (total subject count cannot exceed 2500).
|
||||||
# (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
|
||||||
# "sha256:hex_digest" (e.g. "sha256:abc123..."). Must specify exactly one
|
# "sha256:hex_digest" (e.g. "sha256:abc123..."). Must specify exactly one
|
||||||
# of "subject-path", "subject-digest", or "subject-checksums".
|
# of "subject-path" or "subject-digest".
|
||||||
subject-digest:
|
subject-digest:
|
||||||
|
|
||||||
# Subject name as it should appear in the attestation. Required when
|
# Subject name as it should appear in the attestation. Required unless
|
||||||
# identifying the subject with the "subject-digest" input.
|
# "subject-path" is specified, in which case it will be inferred from the
|
||||||
|
# path.
|
||||||
subject-name:
|
subject-name:
|
||||||
|
|
||||||
# Path to checksums file containing digest and name of subjects for
|
|
||||||
# attestation. Must specify exactly one of "subject-path", "subject-digest",
|
|
||||||
# or "subject-checksums".
|
|
||||||
subject-checksums:
|
|
||||||
|
|
||||||
# Whether to push the attestation to the image registry. Requires that the
|
# Whether to push the attestation to the image registry. Requires that the
|
||||||
# "subject-name" parameter specify the fully-qualified image name and that
|
# "subject-name" parameter specify the fully-qualified image name and that
|
||||||
# the "subject-digest" parameter be specified. Defaults to false.
|
# the "subject-digest" parameter be specified. Defaults to false.
|
||||||
@@ -108,28 +93,26 @@ See [action.yml](action.yml)
|
|||||||
|
|
||||||
<!-- markdownlint-disable MD013 -->
|
<!-- markdownlint-disable MD013 -->
|
||||||
|
|
||||||
| Name | Description | Example |
|
| Name | Description | Example |
|
||||||
| ----------------- | -------------------------------------------------------------- | ------------------------------------------------ |
|
| ------------- | -------------------------------------------------------------- | ------------------------ |
|
||||||
| `attestation-id` | GitHub ID for the attestation | `123456` |
|
| `bundle-path` | Absolute path to the file containing the generated attestation | `/tmp/attestation.jsonl` |
|
||||||
| `attestation-url` | URL for the attestation summary | `https://github.com/foo/bar/attestations/123456` |
|
|
||||||
| `bundle-path` | Absolute path to the file containing the generated attestation | `/tmp/attestation.json` |
|
|
||||||
|
|
||||||
<!-- markdownlint-enable MD013 -->
|
<!-- markdownlint-enable MD013 -->
|
||||||
|
|
||||||
Attestations are saved in the JSON-serialized [Sigstore bundle][6] format.
|
Attestations are saved in the JSON-serialized [Sigstore bundle][6] format.
|
||||||
|
|
||||||
If multiple subjects are being attested at the same time, a single attestation
|
If multiple subjects are being attested at the same time, each attestation will
|
||||||
will be created with references to each of the supplied subjects.
|
be written to the output file on a separate line (using the [JSON Lines][7]
|
||||||
|
format).
|
||||||
The absolute path to the generated attestation is appended to the file
|
|
||||||
`${RUNNER_TEMP}/created_attestation_paths.txt`. This file will accumulate the
|
|
||||||
paths to all attestations created over the course of a single workflow.
|
|
||||||
|
|
||||||
## Attestation Limits
|
## Attestation Limits
|
||||||
|
|
||||||
### Subject Limits
|
### Subject Limits
|
||||||
|
|
||||||
No more than 1024 subjects can be attested at the same time.
|
No more than 2500 subjects can be attested at the same time. Subjects will be
|
||||||
|
processed in batches 50. After the initial group of 50, each subsequent batch
|
||||||
|
will incur an exponentially increasing amount of delay (capped at 1 minute of
|
||||||
|
delay per batch) to avoid overwhelming the attestation API.
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
@@ -147,7 +130,6 @@ on:
|
|||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
build:
|
build:
|
||||||
runs-on: ubuntu-latest
|
|
||||||
permissions:
|
permissions:
|
||||||
id-token: write
|
id-token: write
|
||||||
contents: read
|
contents: read
|
||||||
@@ -159,18 +141,18 @@ jobs:
|
|||||||
- name: Build artifact
|
- name: Build artifact
|
||||||
run: make my-app
|
run: make my-app
|
||||||
- name: Attest
|
- name: Attest
|
||||||
uses: actions/attest-build-provenance@v2
|
uses: actions/attest-build-provenance@v1
|
||||||
with:
|
with:
|
||||||
subject-path: '${{ github.workspace }}/my-app'
|
subject-path: '${{ github.workspace }}/my-app'
|
||||||
```
|
```
|
||||||
|
|
||||||
### Identify Multiple Subjects
|
### Identify Multiple Subjects
|
||||||
|
|
||||||
If you are generating multiple artifacts, you can attest all of them at the same
|
If you are generating multiple artifacts, you can generate a provenance
|
||||||
time by using a wildcard in the `subject-path` input.
|
attestation for each by using a wildcard in the `subject-path` input.
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-build-provenance@v2
|
- uses: actions/attest-build-provenance@v1
|
||||||
with:
|
with:
|
||||||
subject-path: 'dist/**/my-bin-*'
|
subject-path: 'dist/**/my-bin-*'
|
||||||
```
|
```
|
||||||
@@ -182,53 +164,19 @@ Alternatively, you can explicitly list multiple subjects with either a comma or
|
|||||||
newline delimited list:
|
newline delimited list:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-build-provenance@v2
|
- uses: actions/attest-build-provenance@v1
|
||||||
with:
|
with:
|
||||||
subject-path: 'dist/foo, dist/bar'
|
subject-path: 'dist/foo, dist/bar'
|
||||||
```
|
```
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
- uses: actions/attest-build-provenance@v2
|
- uses: actions/attest-build-provenance@v1
|
||||||
with:
|
with:
|
||||||
subject-path: |
|
subject-path: |
|
||||||
dist/foo
|
dist/foo
|
||||||
dist/bar
|
dist/bar
|
||||||
```
|
```
|
||||||
|
|
||||||
### Identify Subjects with Checksums File
|
|
||||||
|
|
||||||
If you are using tools like
|
|
||||||
[goreleaser](https://goreleaser.com/customization/checksum/) or
|
|
||||||
[jreleaser](https://jreleaser.org/guide/latest/reference/checksum.html) which
|
|
||||||
generate a checksums file you can identify the attestation subjects by passing
|
|
||||||
the path of the checksums file to the `subject-checksums` input. Each of the
|
|
||||||
artifacts identified in the checksums file will be listed as a subject for the
|
|
||||||
attestation.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Calculate artifact digests
|
|
||||||
run: |
|
|
||||||
shasum -a 256 foo_0.0.1_* > subject.checksums.txt
|
|
||||||
- uses: actions/attest-build-provenance@v2
|
|
||||||
with:
|
|
||||||
subject-checksums: subject.checksums.txt
|
|
||||||
```
|
|
||||||
|
|
||||||
<!-- markdownlint-disable MD038 -->
|
|
||||||
|
|
||||||
The file referenced by the `subject-checksums` input must conform to the same
|
|
||||||
format used by the shasum tools. Each subject should be listed on a separate
|
|
||||||
line including the hex-encoded digest (either SHA256 or SHA512), a space, a
|
|
||||||
single character flag indicating either binary (`*`) or text (` `) input mode,
|
|
||||||
and the filename.
|
|
||||||
|
|
||||||
<!-- markdownlint-enable MD038 -->
|
|
||||||
|
|
||||||
```text
|
|
||||||
b569bf992b287f55d78bf8ee476497e9b7e9d2bf1c338860bfb905016218c740 foo_0.0.1_darwin_amd64
|
|
||||||
a54fc515e616cac7fcf11a49d5c5ec9ec315948a5935c1e11dd610b834b14dde foo_0.0.1_darwin_arm64
|
|
||||||
```
|
|
||||||
|
|
||||||
### Container Image
|
### Container Image
|
||||||
|
|
||||||
When working with container images you can invoke the action with the
|
When working with container images you can invoke the action with the
|
||||||
@@ -282,7 +230,7 @@ jobs:
|
|||||||
push: true
|
push: true
|
||||||
tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
|
tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:latest
|
||||||
- name: Attest
|
- name: Attest
|
||||||
uses: actions/attest-build-provenance@v2
|
uses: actions/attest-build-provenance@v1
|
||||||
id: attest
|
id: attest
|
||||||
with:
|
with:
|
||||||
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
|
||||||
@@ -290,26 +238,6 @@ jobs:
|
|||||||
push-to-registry: true
|
push-to-registry: true
|
||||||
```
|
```
|
||||||
|
|
||||||
### Integration with `actions/upload-artifact`
|
|
||||||
|
|
||||||
If you'd like to create an attestation for an archive created with the
|
|
||||||
[actions/upload-artifact][11] action you can feed the digest of the generated
|
|
||||||
artifact directly into the `subject-digest` input of the attestation action.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
- name: Upload build artifact
|
|
||||||
id: upload
|
|
||||||
uses: actions/upload-artifact@v4
|
|
||||||
with:
|
|
||||||
path: dist/*
|
|
||||||
name: artifact.zip
|
|
||||||
|
|
||||||
- uses: actions/attest-build-provenance@v2
|
|
||||||
with:
|
|
||||||
subject-name: artifact.zip
|
|
||||||
subject-digest: sha256:${{ steps.upload.outputs.artifact-digest }}
|
|
||||||
```
|
|
||||||
|
|
||||||
[1]: https://github.com/actions/toolkit/tree/main/packages/attest
|
[1]: https://github.com/actions/toolkit/tree/main/packages/attest
|
||||||
[2]: https://github.com/in-toto/attestation/tree/main/spec/v1
|
[2]: https://github.com/in-toto/attestation/tree/main/spec/v1
|
||||||
[3]: https://slsa.dev/spec/v1.0/provenance
|
[3]: https://slsa.dev/spec/v1.0/provenance
|
||||||
@@ -317,8 +245,8 @@ artifact directly into the `subject-digest` input of the attestation action.
|
|||||||
[5]: https://cli.github.com/manual/gh_attestation_verify
|
[5]: https://cli.github.com/manual/gh_attestation_verify
|
||||||
[6]:
|
[6]:
|
||||||
https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto
|
https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto
|
||||||
|
[7]: https://jsonlines.org/
|
||||||
[8]: https://github.com/actions/toolkit/tree/main/packages/glob#patterns
|
[8]: https://github.com/actions/toolkit/tree/main/packages/glob#patterns
|
||||||
[9]:
|
[9]:
|
||||||
https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds
|
https://docs.github.com/en/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds
|
||||||
[10]: https://github.com/sigstore/cosign/blob/main/specs/BUNDLE_SPEC.md
|
[10]: https://github.com/sigstore/cosign/blob/main/specs/BUNDLE_SPEC.md
|
||||||
[11]: https://github.com/actions/upload-artifact
|
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ exports[`main when a non-default OIDC issuer is used successfully run main 1`] =
|
|||||||
"externalParameters": {
|
"externalParameters": {
|
||||||
"workflow": {
|
"workflow": {
|
||||||
"path": ".github/workflows/main.yml",
|
"path": ".github/workflows/main.yml",
|
||||||
"ref": "refs/heads/main",
|
"ref": "main",
|
||||||
"repository": "https://example-01.ghe.com/owner/repo",
|
"repository": "https://example-01.ghe.com/owner/repo",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@@ -46,7 +46,7 @@ exports[`main when the default OIDC issuer is used successfully run main 1`] = `
|
|||||||
"externalParameters": {
|
"externalParameters": {
|
||||||
"workflow": {
|
"workflow": {
|
||||||
"path": ".github/workflows/main.yml",
|
"path": ".github/workflows/main.yml",
|
||||||
"ref": "refs/heads/main",
|
"ref": "main",
|
||||||
"repository": "https://github.com/owner/repo",
|
"repository": "https://github.com/owner/repo",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import * as main from '../src/main'
|
|||||||
const runMock = jest.spyOn(main, 'run').mockImplementation()
|
const runMock = jest.spyOn(main, 'run').mockImplementation()
|
||||||
|
|
||||||
describe('index', () => {
|
describe('index', () => {
|
||||||
it('calls run when imported', () => {
|
it('calls run when imported', async () => {
|
||||||
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
||||||
require('../src/index')
|
require('../src/index')
|
||||||
|
|
||||||
|
|||||||
+9
-24
@@ -9,26 +9,20 @@ inputs:
|
|||||||
subject-path:
|
subject-path:
|
||||||
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", "subject-digest", or
|
specify exactly one of "subject-path" or "subject-digest". May contain a
|
||||||
"subject-checksums". May contain a glob pattern or list of paths
|
glob pattern or list of paths (total subject count cannot exceed 2500).
|
||||||
(total subject count cannot exceed 1024).
|
|
||||||
required: false
|
required: false
|
||||||
subject-digest:
|
subject-digest:
|
||||||
description: >
|
description: >
|
||||||
Digest of the subject for which provenance will be generated. Must be in
|
Digest of the subject for which provenance will be generated. Must be in
|
||||||
the form "algorithm:hex_digest" (e.g. "sha256:abc123..."). Must specify
|
the form "algorithm:hex_digest" (e.g. "sha256:abc123..."). Must specify
|
||||||
exactly one of "subject-path", "subject-digest", or "subject-checksums".
|
exactly one of "subject-path" or "subject-digest".
|
||||||
required: false
|
required: false
|
||||||
subject-name:
|
subject-name:
|
||||||
description: >
|
description: >
|
||||||
Subject name as it should appear in the attestation. Required when
|
Subject name as it should appear in the provenance statement. Required
|
||||||
identifying the subject with the "subject-digest" input.
|
unless "subject-path" is specified, in which case it will be inferred from
|
||||||
subject-checksums:
|
the path.
|
||||||
description: >
|
|
||||||
Path to checksums file containing digest and name of subjects for
|
|
||||||
attestation. Must specify exactly one of "subject-path", "subject-digest",
|
|
||||||
or "subject-checksums".
|
|
||||||
required: false
|
|
||||||
push-to-registry:
|
push-to-registry:
|
||||||
description: >
|
description: >
|
||||||
Whether to push the provenance statement to the image registry. Requires
|
Whether to push the provenance statement to the image registry. Requires
|
||||||
@@ -50,29 +44,20 @@ inputs:
|
|||||||
|
|
||||||
outputs:
|
outputs:
|
||||||
bundle-path:
|
bundle-path:
|
||||||
description: 'The path to the file containing the attestation bundle.'
|
description: 'The path to the file containing the attestation bundle(s).'
|
||||||
value: ${{ steps.attest.outputs.bundle-path }}
|
value: ${{ steps.attest.outputs.bundle-path }}
|
||||||
attestation-id:
|
|
||||||
description: 'The ID of the attestation.'
|
|
||||||
value: ${{ steps.attest.outputs.attestation-id }}
|
|
||||||
attestation-url:
|
|
||||||
description: 'The URL for the attestation summary.'
|
|
||||||
value: ${{ steps.attest.outputs.attestation-url }}
|
|
||||||
|
|
||||||
runs:
|
runs:
|
||||||
using: 'composite'
|
using: 'composite'
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/attest-build-provenance/predicate@1176ef556905f349f669722abf30bce1a6e16e01 # [email protected].5
|
- uses: actions/attest-build-provenance/predicate@36fa7d009e22618ca7cd599486979b8150596c74 # [email protected].4
|
||||||
id: generate-build-provenance-predicate
|
id: generate-build-provenance-predicate
|
||||||
- uses: actions/attest@daf44fb950173508f38bd2406030372c1d1162b1 # v3.0.0
|
- uses: actions/attest@main
|
||||||
id: attest
|
id: attest
|
||||||
env:
|
|
||||||
NODE_OPTIONS: "--max-http-header-size=32768"
|
|
||||||
with:
|
with:
|
||||||
subject-path: ${{ inputs.subject-path }}
|
subject-path: ${{ inputs.subject-path }}
|
||||||
subject-digest: ${{ inputs.subject-digest }}
|
subject-digest: ${{ inputs.subject-digest }}
|
||||||
subject-name: ${{ inputs.subject-name }}
|
subject-name: ${{ inputs.subject-name }}
|
||||||
subject-checksums: ${{ inputs.subject-checksums }}
|
|
||||||
predicate-type: ${{ steps.generate-build-provenance-predicate.outputs.predicate-type }}
|
predicate-type: ${{ steps.generate-build-provenance-predicate.outputs.predicate-type }}
|
||||||
predicate: ${{ steps.generate-build-provenance-predicate.outputs.predicate }}
|
predicate: ${{ steps.generate-build-provenance-predicate.outputs.predicate }}
|
||||||
push-to-registry: ${{ inputs.push-to-registry }}
|
push-to-registry: ${{ inputs.push-to-registry }}
|
||||||
|
|||||||
+1729
-1903
File diff suppressed because it is too large
Load Diff
@@ -1,92 +0,0 @@
|
|||||||
import eslint from '@eslint/js'
|
|
||||||
import importplugin from 'eslint-plugin-import'
|
|
||||||
import jestplugin from 'eslint-plugin-jest'
|
|
||||||
import tseslint from 'typescript-eslint'
|
|
||||||
|
|
||||||
export default tseslint.config(
|
|
||||||
// Ignore non-project files
|
|
||||||
{
|
|
||||||
name: 'ignore',
|
|
||||||
ignores: ['.github', 'dist', 'coverage', '**/*.json', 'jest.setup.js', 'eslint.config.mjs']
|
|
||||||
},
|
|
||||||
// Use recommended rules from ESLint, TypeScript, and other plugins
|
|
||||||
eslint.configs.recommended,
|
|
||||||
tseslint.configs.recommendedTypeChecked,
|
|
||||||
jestplugin.configs['flat/recommended'],
|
|
||||||
importplugin.flatConfigs.recommended,
|
|
||||||
importplugin.flatConfigs.typescript,
|
|
||||||
// Override some rules
|
|
||||||
{
|
|
||||||
name: 'project-settings',
|
|
||||||
languageOptions: {
|
|
||||||
ecmaVersion: 2023,
|
|
||||||
parserOptions: {
|
|
||||||
project: ['./tsconfig.lint.json']
|
|
||||||
}
|
|
||||||
},
|
|
||||||
rules: {
|
|
||||||
// eslint rules
|
|
||||||
eqeqeq: ['error', 'smart'],
|
|
||||||
'func-style': ['error', 'declaration', { allowArrowFunctions: true }],
|
|
||||||
'no-console': 'off',
|
|
||||||
'no-implicit-globals': 'error',
|
|
||||||
'no-inner-declarations': 'error',
|
|
||||||
'no-invalid-this': 'error',
|
|
||||||
'no-return-assign': 'error',
|
|
||||||
'no-sequences': 'error',
|
|
||||||
'no-shadow': 'error',
|
|
||||||
'no-useless-concat': 'error',
|
|
||||||
'object-shorthand': ['error', 'always', { avoidQuotes: true }],
|
|
||||||
'one-var': ['error', 'never'],
|
|
||||||
'prefer-template': 'error',
|
|
||||||
|
|
||||||
// typescript-eslint rules
|
|
||||||
'@typescript-eslint/array-type': 'error',
|
|
||||||
'@typescript-eslint/consistent-type-assertions': 'error',
|
|
||||||
'@typescript-eslint/explicit-function-return-type': [
|
|
||||||
'error',
|
|
||||||
{ allowExpressions: true }
|
|
||||||
],
|
|
||||||
'@typescript-eslint/explicit-member-accessibility': [
|
|
||||||
'error',
|
|
||||||
{ accessibility: 'no-public' }
|
|
||||||
],
|
|
||||||
'@typescript-eslint/no-extraneous-class': 'error',
|
|
||||||
'@typescript-eslint/no-inferrable-types': 'error',
|
|
||||||
'@typescript-eslint/no-non-null-assertion': 'warn',
|
|
||||||
'@typescript-eslint/no-unnecessary-qualifier': 'error',
|
|
||||||
'@typescript-eslint/no-unsafe-assignment': 'off',
|
|
||||||
'@typescript-eslint/no-useless-constructor': 'error',
|
|
||||||
'@typescript-eslint/prefer-for-of': 'warn',
|
|
||||||
'@typescript-eslint/prefer-function-type': 'warn',
|
|
||||||
'@typescript-eslint/prefer-includes': 'error',
|
|
||||||
'@typescript-eslint/prefer-string-starts-ends-with': 'error',
|
|
||||||
'@typescript-eslint/promise-function-async': 'error',
|
|
||||||
'@typescript-eslint/require-array-sort-compare': 'error',
|
|
||||||
'@typescript-eslint/restrict-template-expressions': 'off',
|
|
||||||
|
|
||||||
// eslint-plugin-import rules
|
|
||||||
'import/extensions': 'error',
|
|
||||||
'import/first': 'error',
|
|
||||||
'import/no-absolute-path': 'error',
|
|
||||||
'import/no-commonjs': 'error',
|
|
||||||
'import/no-deprecated': 'warn',
|
|
||||||
'import/no-dynamic-require': 'error',
|
|
||||||
'import/no-extraneous-dependencies': 'error',
|
|
||||||
'import/no-mutable-exports': 'error',
|
|
||||||
'import/no-namespace': 'off',
|
|
||||||
'import/no-unresolved': ['error', { ignore: ['csv-parse/sync'] }],
|
|
||||||
'import/no-anonymous-default-export': [
|
|
||||||
'error',
|
|
||||||
{
|
|
||||||
allowAnonymousClass: false,
|
|
||||||
allowAnonymousFunction: false,
|
|
||||||
allowArray: true,
|
|
||||||
allowArrowFunction: false,
|
|
||||||
allowLiteral: true,
|
|
||||||
allowObject: true
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
)
|
|
||||||
Generated
+2912
-3830
File diff suppressed because it is too large
Load Diff
+22
-19
@@ -1,7 +1,7 @@
|
|||||||
{
|
{
|
||||||
"name": "actions/attest-build-provenance",
|
"name": "actions/attest-build-provenance",
|
||||||
"description": "Generate signed build provenance attestations",
|
"description": "Generate signed build provenance attestations",
|
||||||
"version": "2.0.0",
|
"version": "1.1.4",
|
||||||
"author": "",
|
"author": "",
|
||||||
"private": true,
|
"private": true,
|
||||||
"homepage": "https://github.com/actions/attest-build-provenance",
|
"homepage": "https://github.com/actions/attest-build-provenance",
|
||||||
@@ -21,15 +21,15 @@
|
|||||||
".": "./dist/index.js"
|
".": "./dist/index.js"
|
||||||
},
|
},
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=24"
|
"node": ">=20"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"bundle": "npm run format:write && npm run package",
|
"bundle": "npm run format:write && npm run package",
|
||||||
"ci-test": "jest",
|
"ci-test": "jest",
|
||||||
"format:write": "prettier --write **/*.ts",
|
"format:write": "prettier --write **/*.ts",
|
||||||
"format:check": "prettier --check **/*.ts",
|
"format:check": "prettier --check **/*.ts",
|
||||||
"lint:eslint": "npx eslint",
|
"lint:eslint": "npx eslint . -c ./.github/linters/.eslintrc.yml",
|
||||||
"lint:markdown": "npx markdownlint --config .markdown-lint.yml \"*.md\"",
|
"lint:markdown": "npx markdownlint --config .github/linters/.markdown-lint.yml \"*.md\"",
|
||||||
"lint": "npm run lint:eslint && npm run lint:markdown",
|
"lint": "npm run lint:eslint && npm run lint:markdown",
|
||||||
"package": "ncc build src/index.ts --license licenses.txt",
|
"package": "ncc build src/index.ts --license licenses.txt",
|
||||||
"package:watch": "npm run package -- --watch",
|
"package:watch": "npm run package -- --watch",
|
||||||
@@ -70,24 +70,27 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/attest": "^1.6.0",
|
"@actions/attest": "^1.5.0",
|
||||||
"@actions/core": "^1.11.1"
|
"@actions/core": "^1.11.1"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@eslint/js": "^9.33.0",
|
"@types/jest": "^29.5.14",
|
||||||
"@types/jest": "^30.0.0",
|
"@types/node": "^22.8.7",
|
||||||
"@types/node": "^24.2.1",
|
"@typescript-eslint/eslint-plugin": "^7.17.0",
|
||||||
"@vercel/ncc": "^0.38.3",
|
"@typescript-eslint/parser": "^7.18.0",
|
||||||
"eslint": "^9.33.0",
|
"@vercel/ncc": "^0.38.2",
|
||||||
"eslint-plugin-import": "^2.32.0",
|
"eslint": "^8.57.1",
|
||||||
"eslint-plugin-jest": "^29.0.1",
|
"eslint-plugin-github": "^5.0.2",
|
||||||
"jest": "^30.0.5",
|
"eslint-plugin-jest": "^28.8.3",
|
||||||
|
"eslint-plugin-jsonc": "^2.16.0",
|
||||||
|
"eslint-plugin-prettier": "^5.2.1",
|
||||||
|
"jest": "^29.7.0",
|
||||||
"jose": "^5.9.6",
|
"jose": "^5.9.6",
|
||||||
"markdownlint-cli": "^0.45.0",
|
"markdownlint-cli": "^0.42.0",
|
||||||
"nock": "^14.0.9",
|
"nock": "^13.5.5",
|
||||||
"prettier": "^3.6.2",
|
"prettier": "^3.3.3",
|
||||||
"ts-jest": "^29.4.1",
|
"prettier-eslint": "^16.3.0",
|
||||||
"typescript": "^5.9.2",
|
"ts-jest": "^29.2.5",
|
||||||
"typescript-eslint": "^8.39.0"
|
"typescript": "^5.6.3"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -10,5 +10,5 @@ outputs:
|
|||||||
description: >
|
description: >
|
||||||
URI identifying the type of the predicate.
|
URI identifying the type of the predicate.
|
||||||
runs:
|
runs:
|
||||||
using: node24
|
using: node20
|
||||||
main: ../dist/index.js
|
main: ../dist/index.js
|
||||||
|
|||||||
@@ -5,7 +5,6 @@
|
|||||||
"module": "NodeNext",
|
"module": "NodeNext",
|
||||||
"rootDir": "./src",
|
"rootDir": "./src",
|
||||||
"moduleResolution": "NodeNext",
|
"moduleResolution": "NodeNext",
|
||||||
"isolatedModules": true,
|
|
||||||
"baseUrl": "./",
|
"baseUrl": "./",
|
||||||
"sourceMap": true,
|
"sourceMap": true,
|
||||||
"outDir": "./dist",
|
"outDir": "./dist",
|
||||||
|
|||||||
@@ -1,9 +0,0 @@
|
|||||||
{
|
|
||||||
"$schema": "https://json.schemastore.org/tsconfig",
|
|
||||||
"extends": "./tsconfig.json",
|
|
||||||
"compilerOptions": {
|
|
||||||
"noEmit": true
|
|
||||||
},
|
|
||||||
"include": ["./__tests__/**/*", "./src/**/*"],
|
|
||||||
"exclude": ["./dist", "./node_modules", "./coverage", "*.json"]
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user