Skip to content

README Updates

Darby Freyrequested to merge
readme-updates into main

What does this MR do and why?

I tested setting up this component on a sample project Testing SLSA CI Component (darbyfrey/demodemo!1) and found a few places were I thought the documentation could be improved. Here's a summary of what this MR changes:

  1. Includes the version number in the component reference. This will need to be updated each time we release a new version, but it makes the examples copy/paste-able.
  2. The provenance-verifier reference was incorrect, so this MR fixes it.
  3. Moves RUNNER_GENERATE_ARTIFACTS_METADATA to only the build job, so we're not generating provenance for all jobs.
  4. Moves hello.txt to an variable called ARTIFACT_NAME. I think this makes it a bit easier to follow things through the stages.
  5. Removes all inputs with default values. This way users know exactly what is required of them and makes the setup a bit easier.
  6. Reorders the inputs tables to put the required inputs at the top.

Let me know what you think @jocelynjane @fcatteau @ahuntsman

MR acceptance checklist

Please evaluate this MR against the MR acceptance checklist. It helps you analyze changes to reduce risks in quality, performance, reliability, security, and maintainability.

Screenshots or screen recordings

Screenshots are required for UI changes, and strongly recommended for all other merge requests.

Before After

How to set up and validate locally

Numbered steps to set up and validate the change are strongly suggested.

Merge request reports