Skip to content

Chore: [AEA-0000] - fix param names #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anthony-nhs merged 3 commits into from
Mar 30, 2026
Merged

Chore: [AEA-0000] - fix param names #6

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
545c3fc
fix names
anthony-nhs Mar 30, 2026
249803f
fix cooldown
anthony-nhs Mar 30, 2026
aee16a2
fix name
anthony-nhs Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .github/dependabot.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ updates:
commit-message:
prefix: "Upgrade: [dependabot] - "
cooldown:
default-days: 3
default-days: 7
###################################
# Poetry #########################
###################################
Expand All @@ -37,7 +37,7 @@ updates:
prefix: "Upgrade: [dependabot] - "
versioning-strategy: increase
cooldown:
default-days: 3
default-days: 7
###################################
# NPM workspace ##################
###################################
Expand All @@ -54,4 +54,4 @@ updates:
registries:
- npm-github
cooldown:
default-days: 3
default-days: 7
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This repository contains the shared GitHub Copilot instruction files used across
The action is intended to be called from another repository. It:

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
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
3. Replaces the target repository's Copilot instruction files with the shared versions
4. Creates a signed pull request containing the sync changes

Expand All @@ -35,7 +35,7 @@ Existing copies of those paths in the calling repository are removed before the

| Input | Required | Default | Description |
| --- | --- | --- | --- |
| `common_workflows_ref` | No | `main` | Git ref to check out from the central source repository |
| `copilot_instructions_ref` | No | `main` | Git ref to check out from the eps-copilot-instructions repository |
| `calling_repo_base_branch` | No | `main` | Base branch in the calling repository that the pull request should target |
| `CREATE_PULL_REQUEST_APP_ID` | Yes | None | GitHub App ID used to generate a token for pull request creation |
| `CREATE_PULL_REQUEST_PEM` | Yes | None | GitHub App private key in PEM format |
Expand All @@ -61,7 +61,7 @@ jobs:
- name: Sync shared instructions
uses: NHSDigital/eps-copilot-instructions@95118f6746ca7081258cc7f651dca1c5bb7339f1
with:
common_workflows_ref: main
copilot_instructions_ref: main
calling_repo_base_branch: main
CREATE_PULL_REQUEST_APP_ID: ${{ secrets.CREATE_PULL_REQUEST_APP_ID }}
CREATE_PULL_REQUEST_PEM: ${{ secrets.CREATE_PULL_REQUEST_PEM }}
Expand Down
6 changes: 3 additions & 3 deletions action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
name: Sync Copilot Instructions
description: "Syncs Copilot instructions from the repository to the GitHub Action's metadata file."
inputs:
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"
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Suggested change
description: "The ref to sync from the eps_copilot_instructions repository"
description: "The ref to sync from the NHSDigital/eps-copilot-instructions repository"

Copilot uses AI. Check for mistakes.
required: false
default: "main"
Comment on lines +4 to 7
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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.

Copilot uses AI. Check for mistakes.
calling_repo_base_branch:
Expand All @@ -27,7 +27,7 @@ runs:
- name: Checkout central repo code
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd
with:
ref: ${{ inputs.common_workflows_ref }}
ref: ${{ inputs.copilot_instructions_ref }}
fetch-depth: 0
Comment on lines 29 to 31
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

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

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).

Copilot uses AI. Check for mistakes.
path: eps-copilot-instructions
repository: NHSDigital/eps-copilot-instructions
Expand Down
Loading