Add private repository access to step-uses description#322
Conversation
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
There was a problem hiding this comment.
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-usesdescription 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.
|
@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." |
There was a problem hiding this comment.
Should you use the non-language specific version (to let the docs server redirect based on user preference)?
| "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)
There was a problem hiding this comment.
good catch. I will remove them all in a follow-up PR
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