Skip to content

Add private repository access to step-uses description#322

Merged
ericsciple merged 1 commit intomainfrom
users/ericsciple/26-01-uses-desc
Jan 30, 2026
Merged

Add private repository access to step-uses description#322
ericsciple merged 1 commit intomainfrom
users/ericsciple/26-01-uses-desc

Conversation

@ericsciple
Copy link
Copy Markdown
Collaborator

Update the step-uses description to mention that actions can also be used from private repositories when access is enabled via repository settings.

Fixes #319

Update the step-uses description to mention that actions can also be
used from private repositories when access is enabled via repository
settings.

Fixes #319
@ericsciple ericsciple marked this pull request as ready for review January 30, 2026 04:55
@ericsciple ericsciple requested a review from a team as a code owner January 30, 2026 04:55
Copilot AI review requested due to automatic review settings January 30, 2026 04:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the step-uses description in workflow schema files to clarify that actions can be sourced from private repositories when access is enabled, addressing a common customer confusion point identified in issue #319.

Changes:

  • Updated step-uses description in workflow-v1.0.json to mention private repositories with access enabled and added a documentation link
  • Updated corresponding test expectations in hover.test.ts to match the new description

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
workflow-parser/src/workflow-v1.0.json Updated the step-uses field description to include private repository access information with a link to GitHub documentation
languageservice/src/hover.test.ts Updated test expectations to match the new description text

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@ericsciple
Copy link
Copy Markdown
Collaborator Author

@jsoref fyi only

expect(result).not.toBeUndefined();
expect(result?.contents).toEqual(
"Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image."
"Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, a [private repository with access enabled](https://docs.github.com/en/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), or in a published Docker container image."
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should you use the non-language specific version (to let the docs server redirect based on user preference)?

Suggested change
"Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, a [private repository with access enabled](https://docs.github.com/en/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), or in a published Docker container image."
"Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, a [private repository with access enabled](https://docs.github.com/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), or in a published Docker container image."

It looks like this repository is inconsistent:
https://github.com/search?q=repo%3Aactions%2Flanguageservices%20docs.github.com&type=code

(In which case, the /en should probably removed as a distinct PR)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good catch. I will remove them all in a follow-up PR

@ericsciple ericsciple merged commit fb5c6e4 into main Jan 30, 2026
13 checks passed
@ericsciple ericsciple deleted the users/ericsciple/26-01-uses-desc branch January 30, 2026 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update step uses description and link to docs

4 participants