Skip to content

Commit

Permalink
Bump plugin version in README.md. Update references to Generate Prove…
Browse files Browse the repository at this point in the history
…nance Attestation plugin (#8)
  • Loading branch information
isaacsu authored Sep 17, 2024
1 parent 01ccd4d commit 77221bd
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This plugin authenticates with Buildkite Packages using an [Agent OIDC token](ht
steps:
- label: "Publish Gem"
plugins:
- publish-to-packages#v2.0.0:
- publish-to-packages#v2.1.0:
artifacts: "awesome-logger-*.gem"
registry: "acme-corp/awesome-logger"
```
Expand All @@ -23,7 +23,7 @@ steps:
steps:
- label: "Publish Gem"
plugins:
- publish-to-packages#v2.0.0:
- publish-to-packages#v2.1.0:
artifacts: "awesome-logger-*.gem"
registry: "acme-corp/awesome-logger"
attestations: # optional
Expand All @@ -45,11 +45,11 @@ Buildkite Packages registry to publish to.
- Full format is `<organization>/<registry_name>` (e.g. `acme-corp/awesome-logger`).
- `<organization>` defaults to your Buildkite organization if omitted (e.g. `awesome-logger`).

#### `attestations` (string or list of strings, optional)
#### `attestations` (string or array of strings, optional)

One or more attestations from artifact storage to publish along with each package created from `artifacts`.

Each attestation file must be a valid JSON object. You can use [Generate Build Provenance](https://github.com/buildkite-plugins/generate-build-provenance-buildkite-plugin) plugin to generate a valid build provenance attestation in your Buildkite pipeline.
Each attestation file must be a valid JSON object. You can use [Generate Provenance Attestation](https://github.com/buildkite-plugins/generate-provenance-attestation-buildkite-plugin) plugin to generate a valid SLSA Provenance attestation in your Buildkite pipeline.

If `artifact_build_id` is specified, attestations will be downloaded from the relevant build artifact storage.

Expand Down Expand Up @@ -81,7 +81,7 @@ steps:
- label: "Publish Gem"
depends_on: "build-gem"
plugins:
- publish-to-packages#v2.0.0:
- publish-to-packages#v2.1.0:
artifacts: "awesome-logger-*.gem" # publish from build artifact storage
registry: "acme-corp/awesome-logger"
```
Expand Down Expand Up @@ -121,13 +121,13 @@ steps:
steps:
- label: "Publish Gem"
plugins:
- publish-to-packages#v2.0.0:
- publish-to-packages#v2.1.0:
artifacts: "awesome-logger-*.gem"
registry: "acme-corp/awesome-logger"
artifact_build_id: "${BUILDKITE_TRIGGERED_FROM_BUILD_ID}"
```

### Building and publishing with build provenance attestation
### Building and publishing with a provenance attestation

```yaml
steps:
Expand All @@ -136,14 +136,14 @@ steps:
command: "gem build awesome-logger.gemspec"
artifact_paths: "awesome-logger-*.gem" # upload to build artifact storage
plugins:
- generate-build-provenance#v3.0.0:
- generate-provenance-attestation#v1.0.0:
artifacts: "awesome-logger-*.gem" # publish from build artifact storage
attestation_name: "gem-build.attestation.json"
- label: "Publish Gem"
depends_on: "build-gem"
plugins:
- publish-to-packages#v2.0.0:
- publish-to-packages#v2.1.0:
artifacts: "awesome-logger-*.gem" # publish from build artifact storage
registry: "acme-corp/awesome-logger"
attestations: "gem-build.attestation.json"
Expand Down

0 comments on commit 77221bd

Please sign in to comment.