Skip to content

NAID-3331: NHS best practices for GitHub Actions #338

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
MartinWheelerMT merged 1 commit into from
Jun 3, 2025
Merged

NAID-3331: NHS best practices for GitHub Actions #338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
51 changes: 30 additions & 21 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@

name: 111 Adaptor Build Workflow
on:
pull_request:
Expand All @@ -13,12 +12,14 @@ jobs:
checkstyle:
name: Checkstyle
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout Repository
uses: actions/checkout@v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Setup Java 21 LTS
uses: actions/setup-java@v4
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 #4.7.1
with:
java-version: 21
distribution: 'temurin'
Expand All @@ -35,7 +36,7 @@ jobs:
cp -r ./service/build/reports ./artifacts

- name: Upload Artifacts
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 #v4.6.2
if: always()
with:
name: 'Checkstyle Reports'
Expand All @@ -48,12 +49,14 @@ jobs:
spotbugs:
name: Spotbugs
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout Repository
uses: actions/checkout@v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Setup Java 21 LTS
uses: actions/setup-java@v4
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 #4.7.1
with:
java-version: 21
distribution: 'temurin'
Expand All @@ -70,7 +73,7 @@ jobs:
cp -r ./service/build/reports ./artifacts

- name: Upload Artifacts
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 #v4.6.2
if: always()
with:
name: 'Spotbugs Reports'
Expand All @@ -84,13 +87,15 @@ jobs:
name: Unit Tests
runs-on: ubuntu-latest
needs: [ checkstyle, spotbugs ]
permissions:
contents: read
steps:
- name: Checkout Repository
uses: actions/checkout@v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
with:
fetch-depth: 0
- name: Setup Java 21 LTS
uses: actions/setup-java@v4
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 #4.7.1
with:
java-version: 21
distribution: 'temurin'
Expand All @@ -106,7 +111,7 @@ jobs:
cp -r ./service/build/reports ./artifacts

- name: Upload Artifacts
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 #v4.6.2
if: always()
with:
name: 'Unit Test Reports'
Expand All @@ -120,12 +125,14 @@ jobs:
name: Integration Tests
runs-on: ubuntu-latest
needs: [ checkstyle, spotbugs ]
permissions:
contents: read
steps:
- name: Checkout Repository
uses: actions/checkout@v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Setup Java 21 LTS
uses: actions/setup-java@v4
uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 #4.7.1
with:
java-version: 21
distribution: 'temurin'
Expand Down Expand Up @@ -160,7 +167,7 @@ jobs:
cp -r ./scripts/logs ./artifacts

- name: Upload Artifacts
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 #v4.6.2
if: always()
with:
name: 'Integration Test Reports & Docker Logs'
Expand All @@ -182,11 +189,13 @@ jobs:
name: Generate Build ID
runs-on: ubuntu-latest
needs: [unit-tests, integration-tests]
permissions:
contents: read
outputs:
build-id: ${{ steps.generate.outputs.buildId }}
steps:
- name: Checkout Repository
uses: actions/checkout@v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- id: generate
working-directory: ./scripts
Expand Down Expand Up @@ -223,10 +232,10 @@ jobs:
if: github.actor != 'dependabot[bot]'
steps:
- name: Checkout Repository
uses: actions/checkout@v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

- name: Configure AWS Credentials
uses: aws-actions/configure-aws-credentials@v4
uses: aws-actions/configure-aws-credentials@b47578312673ae6fa5b5096b330d9fbac3d116df # v4.2.1
with:
role-to-assume: arn:aws:iam::${{ secrets.AWS_ACCOUNT_ID }}:role/${{ secrets.AWS_ROLE_TO_ASSUME }}
role-session-name: 111_github_action_build_workflow
Expand Down Expand Up @@ -261,16 +270,16 @@ jobs:
name: "Create Build ID Comment"
needs: [generate-build-id]
continue-on-error: true
permissions: write-all
permissions:
pull-requests: write
runs-on: [ ubuntu-latest ]
steps:
- name: Check out code
uses: actions/checkout@v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Comment PR
uses: thollander/actions-comment-pull-request@v3
uses: thollander/actions-comment-pull-request@24bffb9b452ba05a4f3f77933840a6a841d1b32b # v3.0.1
with:
message: |
Images built and published to ECR using a Build Id of ${{ needs.generate-build-id.outputs.build-id }}
comment-tag: images-built
mode: upsert

mode: upsert