Add links to milestones as a roadmap (slsa-framework#612)

* Add links to milestones as a roadmap for now. * fix link * Add sort to milestones link
ramonpetgrave64 · Jul 25, 2022 · c9f5a43 · c9f5a43
1 parent c489188
commit c9f5a43
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -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)
@@ -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

diff --git a/internal/builders/container/README.md b/internal/builders/container/README.md
@@ -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
 

diff --git a/internal/builders/generic/README.md b/internal/builders/generic/README.md
@@ -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
 
@@ -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