Skip to content

fix(docs): contract names to match getting started #2505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 31, 2025
Merged

fix(docs): contract names to match getting started #2505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9882205
fix(docs): getting started contracts
migmartri Oct 31, 2025
bf9cc5f
fix(docs): getting started contracts
migmartri Oct 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/examples/quickstart/contract-only-materials.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
apiVersion: chainloop.dev/v1
kind: Contract
metadata:
name: contract-only-materials
# DO NOT CHANGE, it's used in the getting started guide
# https://docs.chainloop.dev/get-started
name: myproject-build-container-image
description: Basic contract with materials only
spec:
materials:
Expand All @@ -10,4 +12,4 @@ spec:
- name: sbom
type: SBOM_CYCLONEDX_JSON
- name: vulnerabilities-report
type: SARIF
type: SARIF
5 changes: 3 additions & 2 deletions docs/examples/quickstart/contract-with-policies-oss.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
apiVersion: chainloop.dev/v1
kind: Contract
metadata:
name: contract-with-policies-oss
# DO NOT CHANGE, it's used in the getting started guide
# https://docs.chainloop.dev/get-started
name: myproject-build-container-image
description: Contract with policies for OSS projects
spec:
materials:
Expand All @@ -20,4 +22,3 @@ spec:
- ref: https://raw.githubusercontent.com/chainloop-dev/chainloop/refs/heads/main/docs/examples/policies/sbom/sbom-present.yaml
materials:
- ref: https://raw.githubusercontent.com/chainloop-dev/chainloop/refs/heads/main/docs/examples/policies/sbom/cyclonedx-licenses.yaml

4 changes: 3 additions & 1 deletion docs/examples/quickstart/contract-with-policies.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
apiVersion: chainloop.dev/v1
kind: Contract
metadata:
name: contract-with-policies
# DO NOT CHANGE, it's used in the getting started guide
# https://docs.chainloop.dev/get-started
name: myproject-build-container-image
description: Contract with policies and policy groups for comprehensive checks
spec:
materials:
Expand Down
Loading