From 9882205a1becf4b195977635b550cd32cb7d679d Mon Sep 17 00:00:00 2001 From: Miguel Martinez Date: Fri, 31 Oct 2025 11:48:46 +0100 Subject: [PATCH 1/2] fix(docs): getting started contracts Signed-off-by: Miguel Martinez --- docs/examples/quickstart/contract-only-materials.yaml | 4 ++-- docs/examples/quickstart/contract-with-policies-oss.yaml | 5 +++-- docs/examples/quickstart/contract-with-policies.yaml | 4 +++- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/examples/quickstart/contract-only-materials.yaml b/docs/examples/quickstart/contract-only-materials.yaml index ff500cbc7..d887b91c5 100644 --- a/docs/examples/quickstart/contract-only-materials.yaml +++ b/docs/examples/quickstart/contract-only-materials.yaml @@ -1,7 +1,7 @@ apiVersion: chainloop.dev/v1 kind: Contract metadata: - name: contract-only-materials + name: myproject-build-container-image description: Basic contract with materials only spec: materials: @@ -10,4 +10,4 @@ spec: - name: sbom type: SBOM_CYCLONEDX_JSON - name: vulnerabilities-report - type: SARIF \ No newline at end of file + type: SARIF diff --git a/docs/examples/quickstart/contract-with-policies-oss.yaml b/docs/examples/quickstart/contract-with-policies-oss.yaml index bd8a07673..4d4cce6d8 100644 --- a/docs/examples/quickstart/contract-with-policies-oss.yaml +++ b/docs/examples/quickstart/contract-with-policies-oss.yaml @@ -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: @@ -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 - diff --git a/docs/examples/quickstart/contract-with-policies.yaml b/docs/examples/quickstart/contract-with-policies.yaml index 557c847f4..b61f91548 100644 --- a/docs/examples/quickstart/contract-with-policies.yaml +++ b/docs/examples/quickstart/contract-with-policies.yaml @@ -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: From bf9cc5ff256b43c6d3e56d6182398356f5c003b8 Mon Sep 17 00:00:00 2001 From: Miguel Martinez Date: Fri, 31 Oct 2025 11:49:23 +0100 Subject: [PATCH 2/2] fix(docs): getting started contracts Signed-off-by: Miguel Martinez --- docs/examples/quickstart/contract-only-materials.yaml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/examples/quickstart/contract-only-materials.yaml b/docs/examples/quickstart/contract-only-materials.yaml index d887b91c5..61977d18c 100644 --- a/docs/examples/quickstart/contract-only-materials.yaml +++ b/docs/examples/quickstart/contract-only-materials.yaml @@ -1,6 +1,8 @@ apiVersion: chainloop.dev/v1 kind: Contract metadata: + # 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: