Skip to content

Commit

Permalink
readme: add more diff support info
Browse files Browse the repository at this point in the history
  • Loading branch information
radhermit committed Nov 29, 2024
1 parent 1c03b48 commit e1fc9e3
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# pkgcruft-action

GitHub action that runs [pkgcruft] over an ebuild repo.
GitHub action that runs [pkgcruft] over an ebuild repo and supports showing run
differences between commits including optional PR comment support.

## Inputs

Expand All @@ -15,8 +16,11 @@ from the base commit.

## Example workflow

Note that for diffing to work, the full history of the target repo needs to be
fetched (using the checkout action's `fetch-depth: 0` option in this case).
Note that for the action's diff support to work, the full history of the target
repo needs to be fetched using the checkout action's `fetch-depth: 0` option.
Shallow git repos will only show diff output if the target commit results exist
in the cache.

Also, the action requires using x86-64 Linux runners.

```yaml
Expand Down

0 comments on commit e1fc9e3

Please sign in to comment.