Fix witness run readme #7
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The given example in the README.md has invalid parameters according with action.yml Signed-off-by: Kairo Araujo <kairo.araujo@testifysec.com>
Signed-off-by: Kairo Araujo <kairo.araujo@testifysec.com>
- Reduce the length of README.md source code to less than 100 col to easy maintain - Higlight the parameters in the text Signed-off-by: Kairo Araujo <kairo.araujo@testifysec.com>
Signed-off-by: Kairo Araujo <kairo.araujo@testifysec.com>
kairoaraujo
requested review from
colek42,
mikhailswift,
kriscoleman and
jkjell
If the user copy/paste the example will cause an error in their GHA. ``` Run testifysec/witness-run-action@v0.1 Running command: witness run --archivista-server https://archivista.testifysec.io -a environment -a git -a github -s build --trace false --outfile /tmp/build-attestation.json -- /bin/sh -c make build /home/runner/work/_actions/testifysec/witness-run-action/v0.1/node_modules/@actions/io/lib/io.js:171 throw new Error(`Unable to locate executable file: ${tool}. Please verify either the file path exists or the file can be found within a directory specified by the PATH environment variable. Also check the file mode to verify the file is executable.`); ``` Signed-off-by: Kairo Araujo <kairo.araujo@testifysec.com>
kairoaraujo
force-pushed
the
fix-witness-run-readme
branch
from
a63c023
to
b3b38a4
Compare
jkjell
approved these changes
Feb 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix:
The given example in the README.md has invalid parameters according with action.yml
The
use-sigstoreanduse-archivistaare not correct.Small typo
istance->instanceIf the user copy/paste the example will cause an error in their GHA.
Doc
Reduce the length of README.md source code to less than 100 collums to easy maintain
Highlight the parameters in the text
Add a better example of building the software