https://github.com/srz-zumix/gh-pr-ls-files
This extension or action gets a list of added/deleted/modfied files in a pull request without checkout.
https://github.com/srz-zumix/gh-pr-ls-files
diff gh-extension github-actions
Last synced: 4 months ago
JSON representation
This extension or action gets a list of added/deleted/modfied files in a pull request without checkout.
- Host: GitHub
- URL: https://github.com/srz-zumix/gh-pr-ls-files
- Owner: srz-zumix
- License: mit
- Created: 2024-05-14T15:50:42.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-09T05:47:23.000Z (5 months ago)
- Last Synced: 2025-02-09T06:23:08.212Z (5 months ago)
- Topics: diff, gh-extension, github-actions
- Language: Shell
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# gh-pr-ls-files
This extension or action gets a list of added/deleted/modfied files in a pull request without checkout.
## GitHub CLI Extension
### Getting Started
```sh
gh extension install "srz-zumix/gh-pr-ls-files"
```
```sh
gh pr-ls-files -h
```
```text
gh pr-ls-files
list files in the pull request
-a, --added show added files in the output
-d, --deleted show deleted files in the output
-m, --modified show modified files in the output
-r, --renamed show renamed files in the output
-R, --repo repository name
```
## GitHub Actions Action
### Usage
#### List all files
```yaml
- uses: srz-zumix/gh-pr-ls-files@v1
```
#### List deleted files
```yaml
- uses: srz-zumix/gh-pr-ls-files@v1
with:
deleted: true
```
#### List non-deleted (added/modified/renamed) files
```yaml
- uses: srz-zumix/gh-pr-ls-files@v1
with:
deleted: false
```
### Inputs
#### `pull_request`
pull request number|url|branch. Default: `${{ github.event.pull_request.html_url }}`
#### `repository`
Repository name with owner. For example, srz-zumix/gh-pr-ls-files. Default: `${{ github.repository }}`
#### `added`
show added files in the output.
#### `deleted`
show deleted files in the output.
#### `modified`
show modified files in the output.
#### `renamed`
show renamed files in the output.
#### `filter`
show files with the specified grep filter in the output.
e.g. `".*(\.ino|\.cpp|\.c|\.h|\.hpp|\.hh)$"`
#### `exclude`
exclude files with the specified grep filter in the output.
#### `delimiter`
delimiter for the output.
#### `github_token`
GitHub TOKEN. Default: `github.token`
### Outputs
#### `files`
files in the pull request.
#### `count`
count of files in the pull request.