Skip to content

Commit

Permalink
Remove action-docs.yaml as it does not add value anymore
Browse files Browse the repository at this point in the history
Signed-off-by: Jeroen Knoops <jeroen.knoops@philips.com>
  • Loading branch information
JeroenKnoops authored and marcofranssen committed Nov 30, 2021
1 parent 587690e commit 3125396
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 49 deletions.
34 changes: 0 additions & 34 deletions .github/workflows/action-docs.yaml

This file was deleted.

6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to gothermostat
# Contributing slsa-provenance-action

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

Expand Down Expand Up @@ -31,3 +31,7 @@ In summary:
- tabwidth of 2
- Files end with a newline
- Whitespace is trimmed from the end of a line

### Update README.md

Update README.md when input parameters change.
15 changes: 1 addition & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,14 +193,10 @@ The easiest way to use this action is to add the following into your workflow fi

</details>

<!-- action-docs-description -->
### Description

An action to generate SLSA build provenance for an artifact


<!-- action-docs-description -->
<!-- action-docs-inputs -->
### Inputs

| parameter | description | required | default |
Expand All @@ -209,18 +205,9 @@ An action to generate SLSA build provenance for an artifact
| output_path | path to write build provenance file | `true` | provenance.json |
| github_context | internal (do not set): the "github" context object in json | `true` | ${{ toJSON(github) }} |
| runner_context | internal (do not set): the "runner" context object in json | `true` | ${{ toJSON(runner) }} |
| tag_name | The github release to generate provenance on.
(if set the artifacts will be downloaded from the release and the provenance will be added as an additional release asset.)
| `false` | |
| tag_name | The github release to generate provenance on.\n (if set the artifacts will be downloaded from the release and the provenance will be added as an additional release asset.) | `false` | |
| extra_materials | paths to files containing SLSA v0.1 formatted materials (JSON array) in to include in the provenance | `false` | |



<!-- action-docs-inputs -->
<!-- action-docs-outputs -->

<!-- action-docs-outputs -->

### Available commands

- Generate
Expand Down

0 comments on commit 3125396

Please sign in to comment.