Chore: [AEA-0000] - workflow to sync copilot instructions by anthony-nhs · Pull Request #62 · NHSDigital/eps-common-workflows

anthony-nhs · 2026-02-11T12:56:13Z

Summary

Routine Change

Details

workflow to sync copilot instructions
add copilot instructions to sync to each repo

github-actions · 2026-02-11T12:56:28Z

This PR is linked to a ticket in an NHS Digital JIRA Project. Here's a handy link to the ticket:

AEA-0000

sonarqubecloud · 2026-02-24T08:36:16Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

.github/instructions/languages/INSTRUCTIONS-CLOUDFORMATION.md

.github/instructions/languages/INSTRUCTIONS-JAVA.md

.github/instructions/languages/INSTRUCTIONS-KOTLIN.md

.github/instructions/instructions.intstructions.md

Copilot

Pull request overview

Adds a reusable GitHub Actions workflow and supporting Copilot configuration files intended to sync Copilot instructions from this repository into other repositories via an automated PR.

Changes:

Document a new “Sync Copilot Instructions” reusable workflow in README.md.
Add .github/workflows/sync_copilot.yml to fetch instruction assets from the central repo and open a PR with updates.
Add Copilot instruction assets under .github/instructions/**, plus .github/copilot-instructions.md and a chatmode file.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 18 comments.

Show a summary per file

File	Description
`README.md`	Documents the new sync workflow and provides a usage example.
`.github/workflows/sync_copilot.yml`	Implements the reusable workflow that syncs instructions into a target repo and creates a PR.
`.github/instructions/languages/INSTRUCTIONS-TYPESCRIPT.md`	Adds TypeScript guidance content.
`.github/instructions/languages/INSTRUCTIONS-TERRAFORM.md`	Adds Terraform guidance content.
`.github/instructions/languages/INSTRUCTIONS-SAM.md`	Adds SAM guidance content.
`.github/instructions/languages/INSTRUCTIONS-PYTHON.md`	Adds Python guidance content.
`.github/instructions/languages/INSTRUCTIONS-KOTLIN.md`	Adds Kotlin guidance content.
`.github/instructions/languages/INSTRUCTIONS-JAVA.md`	Adds Java guidance content.
`.github/instructions/languages/INSTRUCTIONS-CLOUDFORMATION.md`	Adds CloudFormation guidance content.
`.github/instructions/languages/INSTRUCTIONS-CDK.md`	Adds CDK guidance content.
`.github/instructions/instructions.intstructions.md`	Adds guidance for authoring instruction files.
`.github/instructions/general/SECURITY.md`	Adds security-focused guidance intended to apply broadly.
`.github/copilot-instructions.md`	Adds base Copilot instructions and links to other instruction files.
`.github/chatmodes/create_instructions.chatmode.md`	Adds a chatmode intended to help generate instruction files.

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

README.md

.github/workflows/sync_copilot.yml

.github/instructions/general/SECURITY.md

.github/copilot-instructions.md

.github/instructions/languages/INSTRUCTIONS-CDK.md

README.md

.github/workflows/sync_copilot.yml

.github/instructions/languages/INSTRUCTIONS-SAM.md

.github/instructions/languages/INSTRUCTIONS-JAVA.md

.github/instructions/general/security.instructions.md

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 9 comments.

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

.github/copilot-instructions.md

.github/instructions/general/security.instructions.md

README.md

.github/workflows/sync_copilot.yml

README.md

.github/workflows/sync_copilot.yml

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.

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

README.md

.github/copilot-instructions.md

README.md

Copilot

Pull request overview

Copilot reviewed 12 out of 12 changed files in this pull request and generated 9 comments.

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

Copilot · 2026-03-30T12:11:18Z

.github/workflows/sync_copilot.yml

+          commit-message: "Upgrade: [dependabot] - sync Copilot instructions"
+          title: "Upgrade: [dependabot] - sync Copilot instructions"


The PR title/commit message uses [dependabot], but the PR will be created by peter-evans/create-pull-request (not Dependabot). In repos that run pr_title_check.yml, this will trigger the "raised by Dependabot" comment, which is inaccurate. Consider using a real ticket reference, or introduce a separate allowed token (e.g., [automation]) and update the title-check workflow accordingly.

Suggested change

commit-message: "Upgrade: [dependabot] - sync Copilot instructions"

title: "Upgrade: [dependabot] - sync Copilot instructions"

commit-message: "Upgrade: sync Copilot instructions"

title: "Upgrade: sync Copilot instructions"

Copilot · 2026-03-30T12:11:18Z

.github/instructions/languages/typescript.instructions.md

@@ -0,0 +1,175 @@
+---
+description: 'Guidelines for writing high-quality, maintainable TypeScript code with best practices for logging, error handling, code organization, naming, formatting, and style.'
+applyTo: '**/*.ts, **/*.tsx'


applyTo: '**/*.ts, **/*.tsx' is likely not a valid glob (the comma/space will typically be treated as literal characters), meaning these instructions may never apply. Prefer a single glob like **/*.{ts,tsx} or split into separate instruction files/patterns.

Suggested change

applyTo: '**/*.ts, **/*.tsx'

applyTo: '**/*.{ts,tsx}'

Copilot · 2026-03-30T12:11:19Z

.github/instructions/project/instructions.md

@@ -0,0 +1,18 @@
+# EPS Common Workflow - copilot instructions


In the heading, "copilot" should be capitalized as "Copilot" for consistency with GitHub naming.

Suggested change

# EPS Common Workflow - copilot instructions

# EPS Common Workflow - Copilot instructions

Copilot · 2026-03-30T12:11:19Z

.github/instructions/project/instructions.md

+# EPS Common Workflow - copilot instructions
+
+## Overview
+This contains common github workflows that are used by other EPS projects


"github" should be capitalized as "GitHub" (brand name) since this file is intended for broad reuse.

Copilot · 2026-03-30T12:11:19Z

.github/instructions/project/instructions.md

+## General
+These rules should be followed for all workflows
+
+*NEVER* use a version number in 3rd party actions or workflows - always use the git commit sha instead


Consider writing "Git commit SHA" (or "commit SHA") instead of "git commit sha" for consistent capitalization of the tool name and acronym.

Suggested change

*NEVER* use a version number in 3rd party actions or workflows - always use the git commit sha instead

*NEVER* use a version number in 3rd party actions or workflows - always use the Git commit SHA instead

Copilot · 2026-03-30T12:11:19Z

.github/instructions/languages/sam.instructions.md

+9. **Build Methods**: Use esbuild for Node.js Lambda functions
+10. **Version Pinning**: Pin Lambda layer versions and runtimes


The numbered list skips from 7 to 9, which looks like a numbering mistake and makes the guidance harder to reference. Renumber the items so the sequence is continuous.

Suggested change

9. **Build Methods**: Use esbuild for Node.js Lambda functions

10. **Version Pinning**: Pin Lambda layer versions and runtimes

8. **Build Methods**: Use esbuild for Node.js Lambda functions

9. **Version Pinning**: Pin Lambda layer versions and runtimes

Copilot · 2026-03-30T12:11:20Z

.github/instructions/languages/sam.instructions.md

+### Standard Parameters
+Always include these common parameters in templates:
+```yaml
+Parameters


In the CloudFormation/SAM example, Parameters is missing the trailing colon (Parameters:). As written, the snippet is invalid YAML/CloudFormation and could mislead users copying it.

Suggested change

Parameters

Parameters:

Copilot · 2026-03-30T12:11:20Z

.github/workflows/sync_copilot.yml

+      contents: write
+      pull-requests: write


permissions.contents is set to write, but this workflow can likely operate with contents: read because the PR creation uses a separate GitHub App token. Consider reducing the default GITHUB_TOKEN permissions to least-privilege (consistent with other workflows like update-dev-container-version.yml).

Suggested change

contents: write

pull-requests: write

contents: read

Copilot · 2026-03-30T12:11:20Z

.github/workflows/sync_copilot.yml

+          ref: ${{ inputs.calling_repo_base_branch }}
+          fetch-depth: 0
+
+      - name: Checkout code


Both checkout steps are named "Checkout code", which makes logs harder to read when debugging. Rename one step to indicate it's checking out NHSDigital/eps-common-workflows (or similar) so it's clear which repo each step refers to.

Suggested change

- name: Checkout code

- name: Checkout eps-common-workflows repository

sonarqubecloud · 2026-03-30T13:30:26Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

anthony-nhs added 9 commits February 9, 2026 10:18

copilot instructions

a03476e

correct title

de58f1c

fix workflow

1a9f978

temp use pr_title_check

93d8627

fix path

8abca15

really correct path

13be5c0

correct path

ad81232

correct input

e9806f2

sync workflow

176b18c

anthony-nhs and others added 6 commits February 12, 2026 10:07

add instructions

9e91e2b

fix sync

03d6e36

Merge branch 'main' into copilot

558ade2

Merge branch 'main' into copilot

c67833d

update trivy

7779798

Merge remote-tracking branch 'origin/main' into copilot

954ad15

anthony-nhs enabled auto-merge (squash) February 24, 2026 09:45

bencegadanyi1-nhs reviewed Feb 24, 2026

View reviewed changes

Merge branch 'main' into copilot

cf14cc5

Copilot AI review requested due to automatic review settings March 27, 2026 14:55

Copilot started reviewing on behalf of anthony-nhs March 27, 2026 14:56 View session

Copilot AI reviewed Mar 27, 2026

View reviewed changes

anthony-nhs added 4 commits March 27, 2026 15:28

sync copilot

a18a8e5

update

b75ba03

tidy

12a9f00

add project instructions

493637f

anthony-nhs requested a review from Copilot March 30, 2026 11:16

Copilot started reviewing on behalf of anthony-nhs March 30, 2026 11:17 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

update following feedback

fd59b52

anthony-nhs requested a review from Copilot March 30, 2026 11:29

Copilot started reviewing on behalf of anthony-nhs March 30, 2026 11:30 View session

Copilot AI reviewed Mar 30, 2026

View reviewed changes

README.md Outdated Show resolved Hide resolved

.github/copilot-instructions.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

anthony-nhs added 2 commits March 30, 2026 12:01

fix readme

eef0db8

fix following feedback

ca094f4

anthony-nhs requested a review from Copilot March 30, 2026 12:05

Copilot started reviewing on behalf of anthony-nhs March 30, 2026 12:05 View session

more update

9be0e99

Copilot AI reviewed Mar 30, 2026

View reviewed changes

connoravo-nhs previously approved these changes Mar 30, 2026

View reviewed changes

anthony-nhs added 3 commits March 30, 2026 13:10

update following comment

fc90a5e

lower permissions

c77b2ac

better comments

060549a

anthony-nhs dismissed connoravo-nhs’s stale review via 060549a March 30, 2026 13:13

anthony-nhs added 2 commits March 30, 2026 13:21

copy from cdk-utils

0187671

tidy

425b4e4

		commit-message: "Upgrade: [dependabot] - sync Copilot instructions"
		title: "Upgrade: [dependabot] - sync Copilot instructions"

		@@ -0,0 +1,18 @@
		# EPS Common Workflow - copilot instructions

	NEVER use a version number in 3rd party actions or workflows - always use the git commit sha instead
	NEVER use a version number in 3rd party actions or workflows - always use the Git commit SHA instead

		9. Build Methods: Use esbuild for Node.js Lambda functions
		10. Version Pinning: Pin Lambda layer versions and runtimes

	- name: Checkout code
	- name: Checkout eps-common-workflows repository

Conversation

anthony-nhs commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Details

Uh oh!

github-actions bot commented Feb 11, 2026

AEA-0000

Uh oh!

sonarqubecloud bot commented Feb 24, 2026

Quality Gate passed

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 30, 2026

anthony-nhs commented Feb 11, 2026 •

edited

Loading