Skip to content

Commit

Permalink
doc: update documentation regarding execution only on upstream repo
Browse files Browse the repository at this point in the history
  • Loading branch information
jamacku committed Feb 17, 2025
1 parent 95a8d25 commit ac20d3a
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,6 @@ permissions:

jobs:
lint:
# TODO: Update repository name to match your upstream repository
if: github.event.repository == 'redhat-plumbers-in-action/differential-shellcheck'
runs-on: ubuntu-latest

permissions:
Expand Down Expand Up @@ -107,6 +105,10 @@ jobs:
>
> _`fetch-depth: 0` is required to run `differential-shellcheck` successfully. It fetches all git history._

> [!TIP]
>
> You can limit execution of `differential-shellcheck` to upstream repository by using `if: github.event.repository == 'your_org/your_repo'` before `runs-on: ubuntu-latest`.

<details>
<summary>Console output example</summary>
<p align="center">
Expand Down

0 comments on commit ac20d3a

Please sign in to comment.