https://github.com/wyrihaximus/github-action-files-in-commit

Lists file in given commit
https://github.com/wyrihaximus/github-action-files-in-commit

commit csv files github github-actions hacktoberfest list

Last synced: about 2 months ago
JSON representation

Lists file in given commit

• Host: GitHub
• URL: https://github.com/wyrihaximus/github-action-files-in-commit
• Owner: WyriHaximus
• License: mit
• Created: 2019-10-16T17:18:01.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-05T05:36:51.000Z (about 1 year ago)
• Last Synced: 2024-10-26T18:14:48.767Z (2 months ago)
• Topics: commit, csv, files, github, github-actions, hacktoberfest, list
• Language: PHP
• Size: 105 KB
• Stars: 5
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Files in commit (range)

Github Action that outputs a CSV list with files changed in the given commit (range).

## Options

This action comes with two modes. You either pass no inputs and it gets the changed file list from the `GITHUB_SHA` 

environment variable. Or you pass it the `baseSha` and `headSha` inputs and it will give you the difference between 

them. Not that only passing in either  `baseSha` or `headSha` results in falling back to listing the changed files in 

`GITHUB_SHA`.

### baseSha

The SHA of the base commit.

* *Required*: `Yes`

* *Type*: `string`

* *Example*: `ce28b7e31f089ce537cdec0ae660a74ccb17230f`

### headSha

The SHA of the head commit.

* *Required*: `Yes`

* *Type*: `string`

* *Example*: `a853c03c1b013aa58deee9a6ff43b7a897f6fab8`

## Output

This action has only one output, namely the `files` output. It will container a CSV list of files that have changed in 

the given commit range. For examples:

* `` - Empty, nothing changed.

* `composer.lock` - Only one file changed.

* `composer.json,composer.lock` - Multiple files changed

## License ##

Copyright 2019 [Cees-Jan Kiewiet](http://wyrihaximus.net/)

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.