Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ahmadnassri/action-changed-files
detect changed files in a Commit or PR
https://github.com/ahmadnassri/action-changed-files
actions changed files
Last synced: 22 days ago
JSON representation
detect changed files in a Commit or PR
- Host: GitHub
- URL: https://github.com/ahmadnassri/action-changed-files
- Owner: ahmadnassri
- License: mit
- Created: 2022-09-13T06:22:15.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-09-13T21:27:01.000Z (about 1 year ago)
- Last Synced: 2024-05-02T05:33:57.018Z (7 months ago)
- Topics: actions, changed, files
- Language: Shell
- Homepage:
- Size: 67.4 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Changed Files
detect and list changed files in push & pull_requests events using `git diff `
[![license][license-img]][license-url]
[![release][release-img]][release-url]
## Usage
``` yaml
# supported events
on:
- push
- pull_request
- pull_request_target
jobs:
job:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0 # ⚠️ required for `push` event
# example 1: list all changed files
- id: changed-files
uses: ahmadnassri/action-changed-files@v1
- run: |
for file in ${{ steps.changed-files.outputs.files }}; do
echo "$file has changed"
done
- if: contains(steps.changed-files.outputs.files, 'package-lock.json')
run: |
echo "package-lock.json has changed"
# example 2: detect specific changes using git pathspec
- id: changed-files-specific
uses: ahmadnassri/action-changed-files@v1
with:
pathspec: ":(top,icase,glob,attr:!vendored)src/components/*/*.jsx"
- if: steps.changed-files-specific.outputs.changed == 'true'
run: |
echo "this step will only run if specific files have changed"
```
> ⚠️ when running on `push` events, a `fetch-depth` of `0` higher is required.
## `push` vs `pull_request`
when running in a `pull_request` / `pull_request_target`, the action will compare the latest commit in the PR *(`HEAD`)* against the PR base BRANCH.
when running in a `push`, the action will compare the latest commit `HEAD` against the earliest commit `HEAD~n`, where `n` is the number of commits present in the `push` event.
## Inputs
| input | required | default | description |
|------------|----------|---------|-----------------------------------------------|
| `pathspec` | ❌ | `*` | [pathspec][] pattern used to look for changes |
> ℹ️ Learn more about [advanced pathspec usage][]
## Outputs
This action will output the following properties:
| property | type | description | example |
|-----------|----------|---------------------------------------|------------------------------------------------------|
| `changed` | `string` | changed flag: `true` / `false` | `true` |
| `files` | `string` | space-separated list of changed files | `README.md package.json package-lock.json` |
| `json` | `json` | json array of changed files | `["README.md", "package.json", "package-lock.json"]` |
[pathspec]: https://git-scm.com/docs/gitglossary#Documentation/gitglossary.txt-aiddefpathspecapathspec
[advanced pathspec usage]: https://css-tricks.com/git-pathspecs-and-how-to-use-them/
----
> Author: [Ahmad Nassri](https://www.ahmadnassri.com/) •
> Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)
[license-url]: LICENSE
[license-img]: https://badgen.net/github/license/ahmadnassri/action-changed-files
[release-url]: https://github.com/ahmadnassri/action-changed-files/releases
[release-img]: https://badgen.net/github/release/ahmadnassri/action-changed-files