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

Small doc changes #55

Merged

Conversation

vdemeester
Copy link
Member

  • Add a little bit more to the README
  • Rename .catalog.yaml to catalog.yaml as dot-files can't be attached to releases.
  • Update design.md

@openshift-ci openshift-ci bot requested a review from otaviof October 17, 2023 09:26
@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 17, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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:

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

- Add a little bit more to the README
- Update `.catalog.yaml` to `catalog.yaml` as dot-files can't be
  attached to releases.

Signed-off-by: Vincent Demeester <[email protected]>
- it mutates the resources to add the version annotation
- it generates the final `catalog.yaml` with hash, digest, signature, …
- it packages the tasks and pipelines in a `tekton-resources.tar.gz` tarball (with READMEs for documentation)
- it (optionally) create, push the tag, create a GitHub release and attach content to it
Copy link
Contributor

Choose a reason for hiding this comment

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

Here I expect users to rely on gh directly, so catalog-cd release will do all the heavy lifting for the user be able to only upload the release.

Copy link
Member Author

Choose a reason for hiding this comment

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

In my head, it was more, something similar to goreleaser. Quite some project using goreleaser do not create any GitHub release using the UI or gh, just rely on the gorelease tool. The idea was kind-of the same 🙃

- Extract the tarball content and merge it with the current catalog available in the `p` branch
- Creates a pull-request to update it
- The pull request checks includes
- Lint the resources
Copy link
Contributor

Choose a reason for hiding this comment

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

And for the future, we should require a proof that catalog-cd probe has run successfully 💡

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe part of the SBOM payload.

Copy link
Contributor

Choose a reason for hiding this comment

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

What is describe above is *required* for the internal launch.

What is missing from here:
- Attestation, SBOM, signature, …
Copy link
Contributor

Choose a reason for hiding this comment

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

Which should go into .catalog.attestation attributes, I think the basic requirements are: https://docs.sigstore.dev/signing/quickstart/#verifying-a-signed-blob

So, we still need to describe:

  • Certificate
  • Signature
  • Identity


What is missing from here:
- Attestation, SBOM, signature, …
- How to validate the task is well tested (so that Red Hat can support it)
Copy link
Contributor

Choose a reason for hiding this comment

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

Then this, plus making sure the image is part of the Red Hat catalog, also, the image itself needs to provide a valid provenance attestation.

Copy link
Contributor

Choose a reason for hiding this comment

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

/cc @savitaashture 🙏

@openshift-ci
Copy link
Contributor

openshift-ci bot commented Oct 17, 2023

@otaviof: GitHub didn't allow me to request PR reviews from the following users: savitaashture.

Note that only openshift-pipelines members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/cc @savitaashture

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@otaviof
Copy link
Contributor

otaviof commented Oct 17, 2023

/lgtm

Let's keep the comments for later conversations, please.

@openshift-ci openshift-ci bot added the lgtm label Oct 17, 2023
@openshift-ci openshift-ci bot merged commit e6a2d0e into openshift-pipelines:main Oct 17, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants