diff --git a/README.md b/README.md index 1d5bbae0098..8bbcdd08343 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,8 @@ Effortlessly track all changed files and directories relative to a target branch * [Features](#features) * [Usage](#usage) + * [On `pull_request`](#on-pull_request) + * [On `push`](#on-push) * [Useful Acronyms](#useful-acronyms) * [Outputs](#outputs) * [Inputs](#inputs) @@ -81,7 +83,6 @@ And many more. > * Ensure that `persist-credentials` is set to `true` when configuring [`actions/checkout`](https://github.com/actions/checkout#usage) if `fetch-depth` isn't set to `0`. > * For repositories that have PRs generated from forks when configuring [`actions/checkout`](https://github.com/actions/checkout#usage) set the `repository` to `${{ github.event.pull_request.head.repo.full_name }}`. See: [Example](https://github.com/tj-actions/changed-files/blob/main/.github/workflows/test.yml#L47-L51) - ### On `pull_request` ```yaml @@ -192,7 +193,7 @@ jobs: echo "List all the files that have changed: ${{ steps.changed-files-yaml.outputs.doc_all_changed_files }}" ``` -### On `push` +### On `push` ```yaml name: CI @@ -256,7 +257,6 @@ jobs: ... ``` - To access more examples, navigate to the [Examples](#examples) section. If you feel generous and want to show some extra appreciation: