Clarify when private actions can be referenced directly#43969
Clarify when private actions can be referenced directly#43969WilliamK112 wants to merge 1 commit intogithub:mainfrom
Conversation
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
github-actions
Bot
added
the
triage
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates workflow syntax documentation to clarify when private/internal actions can be referenced directly, while keeping the checkout-and-local-reference example for cases where it’s still required.
Changes:
- Adds guidance that internal/private actions can sometimes be referenced directly when access is allowed.
- Links to existing settings documentation for enabling access to internal/private components.
- Reframes the existing example as one approach for cases requiring checkout + local reference.
| ### Example: Using an action inside a different private repository than the workflow | ||
|
|
||
| Your workflow must checkout the private repository and reference the action locally. Generate a {% data variables.product.pat_generic %} and add the token as a secret. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) and [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions). | ||
| If the action is in an internal repository, or in a private repository that's configured to allow access from your workflow's repository, you can reference the action directly. For more information, see [Allowing access to components in an internal repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository) and [Allowing access to components in a private repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository). |
There was a problem hiding this comment.
The section title is now narrower than the guidance immediately under it (which covers internal repositories and eligible private repositories). This mismatch can confuse readers scanning headings. Consider broadening the heading (e.g., internal or private repository) or splitting into a short 'Direct reference' subsection plus the existing checkout-based example.
| ### Example: Using an action inside a different private repository than the workflow | ||
|
|
||
| Your workflow must checkout the private repository and reference the action locally. Generate a {% data variables.product.pat_generic %} and add the token as a secret. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) and [AUTOTITLE](/actions/security-guides/using-secrets-in-github-actions). | ||
| If the action is in an internal repository, or in a private repository that's configured to allow access from your workflow's repository, you can reference the action directly. For more information, see [Allowing access to components in an internal repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-an-internal-repository) and [Allowing access to components in a private repository](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#allowing-access-to-components-in-a-private-repository). |
There was a problem hiding this comment.
This sentence is doing a lot at once (multiple conditions + two links) and uses a contraction ('that's'), which many documentation style guides avoid. Consider splitting into two sentences and using 'that is' to improve readability and consistency.
Fixes #34562.
Summary
Validation
git diff --checkcontent/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository.md