diff --git a/actions/check-action-references/README.md b/actions/check-action-references/README.md index 01f0a487b..07d46b152 100644 --- a/actions/check-action-references/README.md +++ b/actions/check-action-references/README.md @@ -1,6 +1,6 @@ # check-action-references -Prevents `uses:` directives from referencing other GitHub actions, within the same repository, not on the _default_ branch. +Prevents `uses:` directives from referencing other GitHub actions, within the same repository, not on the default branch. ## Example @@ -11,13 +11,13 @@ steps: ## How it works -When developing new actions, you could need to reference one from another; since both actions temporarily reside in a new Git branch, you'll need `@bX.Y.Z` in the `use:` directive. +When developing new actions in a repository acting as a library for GitHub Actions, you could need to reference one action from another; since both actions temporarily reside in a new Git branch, you'll have to add `@bX.Y.Z` to the `use:` directive. -This action is designed for pull request validation workflows - as it ensures that all the above `@` tags have been removed between actions belonging to the same repository: only references to the default branch are allowed. +This action is designed for pull request validation workflows - as it ensures that all the above `@` tags have been removed between actions belonging to the same repository: only references to the default branch of the repository are allowed. ## Requirements -- The check is only performed on [composite GitHub actions](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action), written in files having `.yml` extension. +- The check is only performed on [composite GitHub actions](https://docs.github.com/en/actions/sharing-automations/creating-actions/creating-a-composite-action), written in files having `.yml` extension; workflows in the `.github/workflows` directories are always excluded. ## Inputs