Skip to content

Commit afc0534

Browse files
bdehamerCopilotCopilot
authored
Consolidate attestation action references to actions/attest (#60214)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 651f9b8 commit afc0534

File tree

9 files changed

+19
-19
lines changed

9 files changed

+19
-19
lines changed

content/actions/concepts/security/kubernetes-admissions-controller.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To [install the controller](/actions/how-tos/security-for-github-actions/using-a
2323

2424
When the Policy Controller is installed, it will intercept all image pull requests and verify the attestation for the image. The attestation must be stored in the image registry as an [OCI attached artifact](https://oras.land/docs/concepts/reftypes/) containing a [Sigstore Bundle](https://docs.sigstore.dev/about/bundle/) which contains the attestation and cryptographic material (e.g. certificates and signatures) used to verify the attestation. A verification process is then performed that ensures the image was built with the specified build provenance and matches any policies enabled by the cluster administrator.
2525

26-
In order for an image to be verifiable, it must have a valid provenance attestation in the registry, which can be done by enabling the `push-to-registry: true` attribute in the `actions/attest-build-provenance` action. See [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images) for more details on how to generate attestations for container images.
26+
In order for an image to be verifiable, it must have a valid provenance attestation in the registry, which can be done by enabling the `push-to-registry: true` attribute in the `actions/attest` action. See [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images) for more details on how to generate attestations for container images.
2727

2828
### About trust roots and policies
2929

content/actions/how-tos/secure-your-work/use-artifact-attestations/enforce-artifact-attestations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ category:
1414
contentType: how-tos
1515
---
1616

17-
>[!NOTE] Before proceeding, ensure you have enabled build provenance for container images, including setting the `push-to-registry` attribute in the [`attest-build-provenance` action](https://github.com/actions/attest-build-provenance) as documented in [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images). This is required for the Policy Controller to verify the attestation.
17+
> [!NOTE] Before proceeding, ensure you have enabled build provenance for container images, including setting the `push-to-registry` attribute in the [`attest` action](https://github.com/actions/attest) as documented in [Generating build provenance for container images](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds#generating-build-provenance-for-container-images). This is required for the Policy Controller to verify the attestation.
1818
1919
## Getting started with Kubernetes admission controller
2020

content/actions/how-tos/secure-your-work/use-artifact-attestations/increase-security-rating.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ To verify the artifact attestations generated with your builds, you can use [`gh
5151
The `gh attestation verify` command requires either `--owner` or `--repo` flags to be used with it. These flags do two things.
5252

5353
* They tell `gh attestation verify` where to fetch the attestation from. This will always be your caller workflow.
54-
* They tell `gh attestation verify` where the workflow that did the signing came from. This will always be the workflow that uses [`attest-build-provenance` action](https://github.com/actions/attest-build-provenance), which may be a reusable workflow.
54+
* They tell `gh attestation verify` where the workflow that did the signing came from. This will always be the workflow that uses the [`attest` action](https://github.com/actions/attest), which may be a reusable workflow.
5555

5656
You can use optional flags with the `gh attestation verify` command.
5757

content/actions/how-tos/secure-your-work/use-artifact-attestations/manage-attestations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ Use the `created` filter to filter by creation date. To enter a custom date rang
3232

3333
Use the `predicate` filter to filter by the kind of attestation. A predicate is the type of claim that an attestation makes about an artifact, such as "this artifact was built during a particular workflow run and originates from this repository."
3434

35-
* Provenance attestations were created with the `attest-build-provenance` action.
36-
* SBOM attestations were created with the `attest-sbom` action.
35+
* Provenance attestations were created with the `attest` action.
36+
* SBOM attestations were created with the `attest` action using the `sbom-path` input.
3737
* Custom predicate type patterns are **not** supported in the search field, but are supported by the API.
3838

3939
## Deleting attestations

content/actions/how-tos/secure-your-work/use-artifact-attestations/use-artifact-attestations.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ You can use {% data variables.product.prodname_actions %} to generate artifact a
2626
To generate an artifact attestation, you must:
2727

2828
* Ensure you have the appropriate permissions configured in your workflow.
29-
* Include a step in your workflow that uses the [`attest-build-provenance` action](https://github.com/actions/attest-build-provenance).
29+
* Include a step in your workflow that uses the [`attest` action](https://github.com/actions/attest).
3030

31-
When you run your updated workflows, they will build your artifacts and generate an artifact attestation that establishes build provenance. You can view attestations in your repository's **Actions** tab. For more information, see the [`attest-build-provenance`](https://github.com/actions/attest-build-provenance) repository.
31+
When you run your updated workflows, they will build your artifacts and generate an artifact attestation that establishes build provenance. You can view attestations in your repository's **Actions** tab. For more information, see the [`attest`](https://github.com/actions/attest) repository.
3232

3333
### Generating build provenance for binaries
3434

@@ -45,7 +45,7 @@ When you run your updated workflows, they will build your artifacts and generate
4545
4646
```yaml
4747
- name: Generate artifact attestation
48-
uses: actions/attest-build-provenance@v3
48+
uses: actions/attest@v4
4949
with:
5050
subject-path: 'PATH/TO/ARTIFACT'
5151
```
@@ -68,7 +68,7 @@ When you run your updated workflows, they will build your artifacts and generate
6868

6969
```yaml
7070
- name: Generate artifact attestation
71-
uses: actions/attest-build-provenance@v3
71+
uses: actions/attest@v4
7272
with:
7373
subject-name: {% raw %}${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}{% endraw %}
7474
subject-digest: 'sha256:fedcba0...'
@@ -87,9 +87,9 @@ To generate an attestation for an SBOM, you must:
8787

8888
* Ensure you have the appropriate permissions configured in your workflow.
8989
* Create an SBOM for your artifact. For more information, see [`anchore-sbom-action`](https://github.com/marketplace/actions/anchore-sbom-action) in the {% data variables.product.prodname_marketplace %}.
90-
* Include a step in your workflow that uses the [`attest-sbom` action](https://github.com/actions/attest-sbom).
90+
* Include a step in your workflow that uses the [`attest` action](https://github.com/actions/attest) with the `sbom-path` input.
9191

92-
When you run your updated workflows, they will build your artifacts and generate an SBOM attestation. You can view attestations in your repository's **Actions** tab. For more information, see the [`attest-sbom` action](https://github.com/actions/attest-sbom) repository.
92+
When you run your updated workflows, they will build your artifacts and generate an SBOM attestation. You can view attestations in your repository's **Actions** tab. For more information, see the [`attest`](https://github.com/actions/attest) repository.
9393

9494
### Generating an SBOM attestation for binaries
9595

@@ -106,7 +106,7 @@ When you run your updated workflows, they will build your artifacts and generate
106106

107107
```yaml
108108
- name: Generate SBOM attestation
109-
uses: actions/attest-sbom@v2
109+
uses: actions/attest@v4
110110
with:
111111
subject-path: 'PATH/TO/ARTIFACT'
112112
sbom-path: 'PATH/TO/SBOM'
@@ -130,7 +130,7 @@ When you run your updated workflows, they will build your artifacts and generate
130130

131131
```yaml
132132
- name: Generate SBOM attestation
133-
uses: actions/attest-sbom@v2
133+
uses: actions/attest@v4
134134
with:
135135
subject-name: {% raw %}${{ env.REGISTRY }}/PATH/TO/IMAGE{% endraw %}
136136
subject-digest: 'sha256:fedcba0...'
@@ -180,7 +180,7 @@ gh attestation verify oci://ghcr.io/ORGANIZATION_NAME/IMAGE_NAME:test -R ORGANIZ
180180

181181
To verify SBOM attestations, you have to provide the `--predicate-type` flag to reference a non-default predicate. For more information, see [Vetted predicates](https://github.com/in-toto/attestation/tree/main/spec/predicates#vetted-predicates) in the `in-toto/attestation` repository.
182182

183-
For example, the [`attest-sbom` action](https://github.com/actions/attest-sbom) currently supports either SPDX or CycloneDX SBOM predicates. To verify an SBOM attestation in the SPDX format, you can use the following {% data variables.product.prodname_cli %} command.
183+
For example, the [`attest` action](https://github.com/actions/attest) currently supports either SPDX or CycloneDX SBOM predicates. To verify an SBOM attestation in the SPDX format, you can use the following {% data variables.product.prodname_cli %} command.
184184

185185
```bash copy
186186
gh attestation verify PATH/TO/YOUR/BUILD/ARTIFACT-BINARY \

content/actions/tutorials/publish-packages/publish-docker-images.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ jobs:
115115

116116
{% ifversion artifact-attestations %}
117117
- name: Generate artifact attestation
118-
uses: actions/attest-build-provenance@v3
118+
uses: actions/attest@v4
119119
with:
120120
subject-name: index.docker.io/my-docker-hub-namespace/my-docker-hub-repository
121121
subject-digest: {% raw %}${{ steps.push.outputs.digest }}{% endraw %}

content/code-security/how-tos/secure-your-supply-chain/establish-provenance-and-integrity/upload-linked-artifacts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ You can upload data to the {% data variables.product.virtual_registry %} in the
7777

7878
In the following example, we build and publish a Docker image, then use the `{% raw %}${{ steps.push.outputs.digest }}{% endraw %}` output in the next step to generate a provenance attestation.
7979

80-
The `attest-build-provenance` action automatically uploads a storage record to the {% data variables.product.virtual_registry %} when `push-to-registry: true` is set and the workflow includes the `artifact-metadata: write` permission.
80+
The `attest` action automatically uploads a storage record to the {% data variables.product.virtual_registry %} when `push-to-registry: true` is set and the workflow includes the `artifact-metadata: write` permission.
8181

8282
``` yaml
8383
{% raw %}
@@ -108,7 +108,7 @@ jobs:
108108
${{ env.ACR_ENDPOINT }}/${{ env.IMAGE_NAME }}:${{ github.sha }}
109109
110110
- name: Generate artifact attestation
111-
uses: actions/attest-build-provenance@v3
111+
uses: actions/attest@v4
112112
with:
113113
subject-name: ${{ env.ACR_ENDPOINT }}/${{ env.IMAGE_NAME }}
114114
subject-digest: ${{ steps.push.outputs.digest }}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
The [attest](https://github.com/actions/attest) and [attest-build-provenance](https://github.com/actions/attest-build-provenance) actions automatically create storage records on the {% data variables.product.virtual_registry %} if both:
1+
The [attest](https://github.com/actions/attest) action automatically creates storage records on the {% data variables.product.virtual_registry %} if both:
22

33
* The `push-to-registry` option is set to `true`
44
* The workflow that includes the action has the `artifact-metadata: write` permission

data/reusables/package_registry/publish-docker-image.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ jobs:
5757
{% ifversion artifact-attestations %}
5858
# This step generates an artifact attestation for the image, which is an unforgeable statement about where and how it was built. It increases supply chain security for people who consume the image. For more information, see [Using artifact attestations to establish provenance for builds](/actions/security-guides/using-artifact-attestations-to-establish-provenance-for-builds).
5959
- name: Generate artifact attestation
60-
uses: actions/attest-build-provenance@v3
60+
uses: actions/attest@v4
6161
with:
6262
subject-name: {% raw %}${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}{% endraw %}
6363
subject-digest: {% raw %}${{ steps.push.outputs.digest }}{% endraw %}

0 commit comments

Comments
 (0)