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.

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

Jump to bottom

Add user-facing doc "SLSA Provenance" #913

Merged
merged 1 commit into from
Oct 12, 2023
Merged

Add user-facing doc "SLSA Provenance" #913

merged 1 commit into from
Oct 12, 2023

Conversation

chuangw6
Copy link
Member

@chuangw6 chuangw6 commented Sep 1, 2023 •
edited
Loading

Changes

Fixes #786

The doc includes instruction on how to configure a pipeline/task so that Tekton Chains can generate SLSA provenance properly.

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
  • 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

Add user facing doc that includes instructions on how to configure pipeline/task so that Chains can generate SLSA provenance properly.

@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 1, 2023
@chuangw6
Copy link
Member Author

chuangw6 commented Sep 1, 2023

cc @chitrangpatel @wlynch @lcarva PTAL. Any feedback would be appreciated! Thanks

@chuangw6 chuangw6 force-pushed the add-user-doc branch 3 times, most recently from 0855525 to 66d9065 Compare September 1, 2023 19:40
wlynch
wlynch requested changes Sep 1, 2023
View reviewed changes
Copy link
Member

@wlynch wlynch left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks for putting this together!

This looks like a mix between the existing type hinting docs and tutorials that include lifecycle information. 🤔

I'd like to avoid duplicating / fragmenting docs if we can. I think most of this information is already present in https://github.com/tektoncd/chains/blob/main/docs/intoto.md. Can we consolidate these docs together?

@chuangw6
Copy link
Member Author

chuangw6 commented Sep 2, 2023 •
edited
Loading

I'd like to avoid duplicating / fragmenting docs if we can. I think most of this information is already present in https://github.com/tektoncd/chains/blob/main/docs/intoto.md. Can we consolidate these docs together?

Yeah, type hinting is also mentioned in https://github.com/tektoncd/chains/blob/main/docs/config.md#chains-type-hinting.

I'll consolidate those docs

@tekton-robot tekton-robot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 6, 2023
@chuangw6
Copy link
Member Author

chuangw6 commented Sep 6, 2023

Hi @wlynch, I've cleaned up the docs. PTAL. It turns out the intoto.md file can be completely removed. Most contents are covered in the new doc in a more structured way.

I also added a reference to the build type doc that @chitrangpatel is working on in #906.

@chuangw6 chuangw6 requested a review from wlynch September 6, 2023 15:57
@chuangw6 chuangw6 force-pushed the add-user-doc branch 3 times, most recently from e13acb8 to 36763a8 Compare September 6, 2023 16:17
wlynch
wlynch requested changes Sep 12, 2023
View reviewed changes
docs/how-to-chain-with-pipeline.md Outdated Show resolved Hide resolved
docs/how-to-chain-with-pipeline.md Outdated Show resolved Hide resolved
docs/how-to-chain-with-pipeline.md Outdated Show resolved Hide resolved
docs/how-to-chain-with-pipeline.md Outdated Show resolved Hide resolved
docs/how-to-chain-with-pipeline.md Outdated
Comment on lines 37 to 42
- SLSA v1.0 provenance: `slsa/v2alpha2`
- SLSA v0.2 provenance: `slsa/v1` or `in-toto`
Copy link
Member

Choose a reason for hiding this comment

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

Table-ify this

Copy link
Member

Choose a reason for hiding this comment

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

This is where it would make sense to include links to the different slsa spec docs

Copy link
Member Author

Choose a reason for hiding this comment

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

Table-ify this

Done!

This is where it would make sense to include links to the different slsa spec docs

SGTM.

@chitrangpatel Assume this PR might be merged first, could you please add link to spec doc once #906 is merged? Thanks

docs/how-to-chain-with-pipeline.md Outdated Show resolved Hide resolved
docs/how-to-chain-with-pipeline.md Outdated Show resolved Hide resolved
docs/how-to-chain-with-pipeline.md Outdated Show resolved Hide resolved
docs/how-to-chain-with-pipeline.md Outdated Show resolved Hide resolved
docs/config.md Show resolved Hide resolved
This was referenced Sep 13, 2023
Closed
Merged
Closed
@chuangw6 chuangw6 force-pushed the add-user-doc branch 3 times, most recently from abff964 to c4f3956 Compare October 5, 2023 21:09
@chuangw6 chuangw6 changed the title Add user-facing doc "how to chain with pipeline" Add user-facing doc "SLSA Provenance" Oct 5, 2023
@chuangw6 chuangw6 requested a review from wlynch October 5, 2023 21:14
@chuangw6
Copy link
Member Author

chuangw6 commented Oct 5, 2023

@wlynch Thank you for taking your time to review. I've incorporated all of your suggestions. Please take another look and let me know if you have any other comments/questions.

Thanks again!

wlynch
wlynch reviewed Oct 11, 2023
View reviewed changes
Copy link
Member

@wlynch wlynch left a comment

Choose a reason for hiding this comment

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

LGTM besides a link fix!

docs/config.md Outdated Show resolved Hide resolved
@chuangw6 chuangw6 requested a review from wlynch October 11, 2023 16:01
@chitrangpatel
Copy link
Contributor

/test pull-tekton-chains-integration-tests

@chitrangpatel
Copy link
Contributor

/approve

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 11, 2023
@chuangw6
Add user-facing doc "SLSA Provenance"
2530dcb 
Fixes tektoncd#786

The doc includes instruction on how to configure a pipeline/task so that
Tekton Chains can generate provenance properly.

Signed-off-by: Chuang Wang <[email protected]>
wlynch
wlynch approved these changes Oct 12, 2023
View reviewed changes
Copy link
Member

@wlynch wlynch left a comment

Choose a reason for hiding this comment

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

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 12, 2023
@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: chitrangpatel, wlynch

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

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [chitrangpatel,wlynch]

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 merged commit 8e4ad5e into tektoncd:main Oct 12, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wlynch wlynch wlynch approved these changes

@lcarva lcarva Awaiting requested review from lcarva

@priyawadhwa priyawadhwa Awaiting requested review from priyawadhwa

Assignees

@wlynch wlynch

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Call for a doc on how to use Pipelines with Chains
4 participants
@chuangw6 @chitrangpatel @tekton-robot @wlynch