Skip to content
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.

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

Add buildType for Chains format slsa/v2alpha2 (SLSAv1.0 predicate). #906

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

chitrangpatel
Copy link
Contributor

@chitrangpatel chitrangpatel commented Aug 25, 2023

Changes

Fixes #890

This PR adds the build type for the implementation of the SLSA format v2alpha2 as per issue #797.

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

Add buildType for Chains format slsa/v2alpha2 (SLSAv1.0 preficate).

/kind documentation

Looks something like this on locally hosted tekton website:
Screenshot 2023-08-30 at 10 38 33 AM

@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please ask for approval from chitrangpatel after the PR has been reviewed.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Aug 25, 2023
@tekton-robot tekton-robot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Aug 25, 2023
@chitrangpatel chitrangpatel force-pushed the buildtype branch 4 times, most recently from 4333990 to aaaa781 Compare August 30, 2023 14:37
@chitrangpatel
Copy link
Contributor Author

/assign @wlynch @chuangw6 @lcarva

# Description

```
"buildType": "https://tekton.dev/docs/chains/buildtype-v2"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the right build type?

I don't know if we should be pointing to /docs/ page - I'd prefer to carve out a more dedicated space e.g. https://tekton.dev/predicate/chains/run/v2alpha1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This url is what would appear if we simply merged this doc as is. This is what the Tekton Website would point to. I can certainly work towards making changes in the Tekton website as well such that the url is what we desire.

Let me start by trying to achieve something like this: https://tekton.dev/predicate/chains/run/v2alpha1

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is now "buildType": "https://tekton.dev/predicate/chains/slsa/v2"

docs/buildtype/buildtype-v2.md Outdated Show resolved Hide resolved
docs/buildtype/buildtype-v2.md Outdated Show resolved Hide resolved
docs/buildtype/buildtype-v2.md Outdated Show resolved Hide resolved
Copy link
Member

@chuangw6 chuangw6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you @chitrangpatel for writing this up!

docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Show resolved Hide resolved
docs/predicate/slsa/v2.md Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
@chitrangpatel chitrangpatel changed the title Add buildType for Chains format slsa/v2alpha2 (SLSAv1.0 preficate). Add buildType for Chains format slsa/v2alpha2 (SLSAv1.0 predicate). Oct 11, 2023
This PR adds the build type for the implementation of the SLSA format
v2alpha2 as per issue tektoncd#797.
Copy link

@lehors lehors left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mean to be pedantic but I used your samples as input to test a provenance validator and found a few typos in the json.
Also I should note that I don't believe it is valid for a URI to be relative as in:

"uri": "gcr.io/tekton-releases/github.com/tektoncd/pipeline/cmd/git-init",

Otherwise this looks good to me.
Thanks for working on adding support for SLSA 1.0!

docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
docs/predicate/slsa/v2.md Outdated Show resolved Hide resolved
pulling in suggested changes.

Co-authored-by: Arnaud J Le Hors <[email protected]>
Copy link

linux-foundation-easycla bot commented Dec 15, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@lehors
Copy link

lehors commented Feb 16, 2024

Folks, I apologize for not realizing that this was blocked by my (simple) contribution not being covered by my company's CLA. I got this addressed and hope you can proceed with merging this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/documentation Categorizes issue or PR as related to documentation. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Build Type and Documentation for SLSA 1.0 provenance
7 participants