diff --git a/.github/workflows/action-docs.yaml b/.github/workflows/action-docs.yaml deleted file mode 100644 index 2a1e6d4b..00000000 --- a/.github/workflows/action-docs.yaml +++ /dev/null @@ -1,34 +0,0 @@ -# Workflow to keep action docs up to date - -name: 'Action docs' -on: - push: - branches-ignore: - - main - pull_request: - types: [ opened, reopened ] - -jobs: - update: - runs-on: ubuntu-20.04 - steps: - - uses: actions/checkout@v2.4.0 - - - uses: npalm/action-docs-action@v1.1.0 - with: - tocLevel: 3 - actionFile: action.yaml - - - name: Verify docs are updated - run: | - if [ "$(git status --porcelain)" != "" ] ; then - git diff - exit 1 - fi - - # - name: Update readme in the repository - # if: github.event_name != 'pull_request' - # uses: stefanzweifel/git-auto-commit-action@v4.12.0 - # with: - # commit_message: ":memo: Update Readme" - # file_pattern: README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ffa760e1..25ab4dc9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to gothermostat +# Contributing slsa-provenance-action :+1::tada: First off, thanks for taking the time to contribute! :tada::+1: @@ -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. diff --git a/README.md b/README.md index 73925c43..c252a44e 100644 --- a/README.md +++ b/README.md @@ -193,14 +193,10 @@ The easiest way to use this action is to add the following into your workflow fi - ### Description An action to generate SLSA build provenance for an artifact - - - ### Inputs | parameter | description | required | default | @@ -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` | | - - - - - - - ### Available commands - Generate