diff --git a/README.md b/README.md index b138995..212d5cd 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,8 @@ # go-hashfiles -This action is to compute the SHA256 hash of specified files. +This action is to compute the SHA256 checksum of specified files. -The hash function is based on [nektos/act](https://github.com/nektos/act/blob/ac5dd8feb876d37ae483376a137c57383577dace/pkg/exprparser/functions.go#L183). Thanks! - -**NOTE:** This action is written in Go. Please setup the Go environment before running this action or use a runner with Go environment installed. +**NOTE:** This action is written in Go. Please make sure the `runs-on` runner supports running Go actions. ## Usage @@ -16,7 +14,7 @@ The hash function is based on [nektos/act](https://github.com/nektos/act/blob/ac workdir: '' # The patterns used to match files. - # Multiple patterns should be seperated by `\n` + # Multiple patterns should be seperated with `\n` patterns: '' ``` @@ -24,16 +22,11 @@ The hash function is based on [nektos/act](https://github.com/nektos/act/blob/ac |Output Item|Description| |---|---| -|hash|The computed hash result| +|hash|The computed checksum| |matched-files|The files matched by the patterns| ## Example ``` yml -# Setup the Go environment. This step can be skipped if Go has been installed. -- uses: actions/setup-go@v3 - with: - go-version: '1.20' - - uses: actions/go-hashfiles@v0.0.1 id: get-hash with: @@ -41,7 +34,6 @@ The hash function is based on [nektos/act](https://github.com/nektos/act/blob/ac go.sum ./admin/* **/package-lock.json - - name: Echo hash run: echo ${{ steps.get-hash.outputs.hash }} ``` diff --git a/action.yml b/action.yml index de4df0e..292c929 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ name: 'Go HashFiles' -description: 'Compute the SHA256 hash of specified files' +description: 'Compute the SHA256 checksum of specified files' inputs: workdir: description: > @@ -13,7 +13,7 @@ inputs: required: true outputs: hash: - description: 'The computed hash result' + description: 'The computed checksum' matched-files: description: 'The files matched by the patterns' runs: