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

[feature] Builder ref in documentation should match the latest stable release #1188

Closed
laurentsimon opened this issue Nov 1, 2022 · 4 comments · Fixed by #1266
Closed

[feature] Builder ref in documentation should match the latest stable release #1188

laurentsimon opened this issue Nov 1, 2022 · 4 comments · Fixed by #1266
Labels
type:documentation Improvements or additions to documentation type:feature New feature or request

Comments

@laurentsimon
Copy link
Collaborator

We have struggled to keep the ref of the builder in the documentation in sync with the latest stable builder we'd like people to use.

Let's:

  1. Add it to RELEASE.md process
  2. Add an automated pre-release test to verify the refs are set properly. We do already have some pre-release tests but not for docs (https://github.com/slsa-framework/slsa-github-generator/blob/main/.github/workflows/release.yml#L19)
@laurentsimon laurentsimon added type:feature New feature or request status:triage Issue that has not been triaged labels Nov 1, 2022
@laurentsimon
Copy link
Collaborator Author

/cc @pnacht

@laurentsimon laurentsimon removed the status:triage Issue that has not been triaged label Nov 1, 2022
@laurentsimon laurentsimon mentioned this issue Nov 1, 2022
Merged
@laurentsimon laurentsimon added the type:documentation Improvements or additions to documentation label Nov 2, 2022
@laurentsimon
Copy link
Collaborator Author

@asraa shall we resolve this issue before cutting a new builder release?

@pnacht
Copy link
Contributor

pnacht commented Nov 2, 2022

I've written up a PR that adds this check. However, I'm OOO right now, will submit it once I get back!

@asraa
Copy link
Collaborator

asraa commented Nov 2, 2022

SG, thanks @pnacht

@pnacht pnacht mentioned this issue Nov 2, 2022
Closed
@pnacht pnacht mentioned this issue Nov 25, 2022
Merged
ianlewis pushed a commit that referenced this issue Jan 17, 2023
@pnacht
ci: Ensure documentation is up-to-date with latest release (#1266)
12cc8f0 
Closes #1188. This is a resubmission of #1193 after I tripped over myself on a simple rebase 🤦‍♂️.

- Adds pre-release test to ensure all documentation points to the new release tag
- If not, logs all cases in the format:
  `filename:line-number: [...]/action-name.yml@_wrong-tag_`
  i.e.
  `/internal/builders/go/README.md:205: [...]/builder_go_slsa3.yml@v1.2.0`
  This removes the clutter that comes from the entire `uses: ...` path, as well as adding the line numbers of all infractions
- Also adopts this format for the internal Actions test
- Change to .github/actions/README.md to conform with other placeholders (would otherwise fail the documentation check)
- Modifies RELEASE.md, moving documentation-update up to the "pre-release" stage, to align with new pre-release test

As-is, the documentation check only detects tags within a "workflow chunk" (that is, containing a `uses:` term).

Signed-off-by: Pedro Kaj Kjellerup Nacht <pnacht@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type:documentation Improvements or additions to documentation type:feature New feature or request
Projects
None yet
Milestone
No milestone
3 participants
@asraa @pnacht @laurentsimon