Skip to content

Commit

Permalink
Revise check-action-references
Browse files Browse the repository at this point in the history
  • Loading branch information
giancosta86 committed Sep 4, 2024
1 parent 6150502 commit 0a05c9f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions actions/check-action-references/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand Down

0 comments on commit 0a05c9f

Please sign in to comment.