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

Add links to milestones as a roadmap #612

Merged
merged 4 commits into from
Jul 25, 2022
+13 −3
Merged

Add links to milestones as a roadmap #612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e9cbfef
Add links to milestones as a roadmap for now.
Jul 22, 2022
267337d
fix link
Jul 22, 2022
e84c0b4
Add sort to milestones link
Jul 22, 2022
a0a4dc1
Merge branch 'main' into roadmap-link
Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ This repository contains the code, examples and technical design for system desc

---

- [Roadmap](#roadmap)
- [Generation of provenance](#generation-of-provenance)
- [Builders](#builders)
- [Provenance-only generators](#provenance-only-generators)
Expand All @@ -25,6 +26,13 @@ This repository contains the code, examples and technical design for system desc

---

## Roadmap

The project roadmap is tracked via milestones. You can track progress and open
issues via the [milestones page](https://github.com/slsa-framework/slsa-github-generator/milestones?direction=asc&sort=due_date&state=open).
Each milestone includes a description of what is being worked on and a rough
timeline for completion.

## Generation of provenance

Below we describe the various builders and generators in this repository. They let you build and / or generate non-forgeable provenance
Expand Down
3 changes: 2 additions & 1 deletion internal/builders/container/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ project simply generates provenance as a separate step in an existing workflow.
## Project Status

This workflow is currently under active development. The API could change while
approaching an initial release.
approaching an initial release. You can track progress towards General
Availability via [this milestone](https://github.com/slsa-framework/slsa-github-generator/milestone/3).

## Benefits of Provenance

Expand Down
5 changes: 3 additions & 2 deletions internal/builders/generic/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,8 @@ project simply generates provenance as a separate step in an existing workflow.
## Project Status

This project is currently under active development. The API could change while
approaching an initial release.
approaching an initial release. You can track progress towards General
Availability via [this milestone](https://github.com/slsa-framework/slsa-github-generator/milestone/2).

## Benefits of Provenance

Expand Down Expand Up @@ -193,7 +194,7 @@ The [generic workflow](https://github.com/slsa-framework/slsa-github-generator/b
| ------------------ | -------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `base64-subjects` | yes | | Artifact(s) for which to generate provenance, formatted the same as the output of sha256sum (SHA256 NAME\n[...]) and base64 encoded. The encoded value should decode to, for example: `90f3f7d6c862883ab9d856563a81ea6466eb1123b55bff11198b4ed0030cac86 foo.zip` |
| `upload-assets` | no | false | If true provenance is uploaded to a GitHub release for new tags. |
| `attestation-name` | no | "attestation.intoto.jsonl" | The artifact name of the signed provenance. The file must have the `intoto.jsonl` extension. |
| `attestation-name` | no | "attestation.intoto.jsonl" | The artifact name of the signed provenance. The file must have the `intoto.jsonl` extension. |

### Workflow Outputs

Expand Down