Conversation
|
This PR is linked to a ticket in an NHS Digital JIRA Project. Here's a handy link to the ticket: AEA-0000 |
There was a problem hiding this comment.
Pull request overview
Updates the composite action and documentation to use a new input name for selecting the ref used when checking out the central eps-copilot-instructions repository.
Changes:
- Renames action input from
common_workflows_reftocopilot_instructions_ref. - Updates the checkout step to use the renamed input.
- Updates README input table and example workflow to the renamed input.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| action.yml | Renames the action input and updates the checkout step to use it. |
| README.md | Updates documentation and usage example to reflect the new input name. |
| with: | ||
| ref: ${{ inputs.common_workflows_ref }} | ||
| ref: ${{ inputs.copilot_instructions_ref }} | ||
| fetch-depth: 0 |
There was a problem hiding this comment.
The action still references ${{ inputs.common_workflows_ref }} later in this file (in the create-pull-request body), but that input was renamed to copilot_instructions_ref. Update the remaining reference to the new input name so the PR body shows the correct ref (and to avoid referencing an undefined input).
|
|
||
| 1. Checks out the calling repository at the requested base branch | ||
| 2. Checks out the central source repository at the requested ref | ||
| 2. Checks out copilot instruction files from copilot_instructions_ref repository at the requested ref |
There was a problem hiding this comment.
Step 2 description is inaccurate: copilot_instructions_ref is an input (a git ref), not a repository. Reword this to say the action checks out NHSDigital/eps-copilot-instructions at copilot_instructions_ref (or similar) so readers understand what is being checked out.
| common_workflows_ref: | ||
| description: "The ref to sync from the central repository" | ||
| copilot_instructions_ref: | ||
| description: "The ref to sync from the eps_copilot_instructions repository" |
There was a problem hiding this comment.
copilot_instructions_ref input description mentions eps_copilot_instructions (underscore), but the repository being checked out is NHSDigital/eps-copilot-instructions (hyphens). Update the description so the input help text matches the actual repo name to avoid confusion for action consumers.
| description: "The ref to sync from the eps_copilot_instructions repository" | |
| description: "The ref to sync from the NHSDigital/eps-copilot-instructions repository" |
| copilot_instructions_ref: | ||
| description: "The ref to sync from the eps_copilot_instructions repository" | ||
| required: false | ||
| default: "main" |
There was a problem hiding this comment.
This PR renames the public action input from common_workflows_ref to copilot_instructions_ref, which is a breaking change for any callers using the old input name. Consider supporting common_workflows_ref as a deprecated alias (or documenting a required major version/tag bump) to avoid unexpected failures for existing users.
Summary
Details