Skip to content

Commit 8936d97

Browse files
stevebuxmasl2
stevebux
and
masl2
authored
CCM-13419 Generate Spec Variants (#319)
* CCM-13419 Generate Specification Variants on Build (#301) * CCM-13419 Refactor build steps * CCM-13419 Generate specification variants on build * Add permissions * Post review comment * Only build OAS variants if push is to main --------- Co-authored-by: Mark Slowey <113013138+masl2@users.noreply.github.com> * Build yml oas spec --------- Co-authored-by: Mark Slowey <113013138+masl2@users.noreply.github.com>
1 parent 2a2801a commit 8936d97

7 files changed

Lines changed: 172 additions & 83 deletions

File tree

‎.github/actions/build-oas-spec/action.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: "Build OAS Spec"
2+
description: "Build OAS Spec"
3+
4+
inputs:
5+
version:
6+
description: "Version number"
7+
required: true
8+
apimEnv:
9+
description: "APIM environment"
10+
required: true
11+
buildSandbox:
12+
description: "Whether to build the sandbox OAS spec"
13+
required: false
14+
default: false
15+
nodejs_version:
16+
description: "Node.js version, set by the CI/CD pipeline workflow"
17+
required: true
18+
NODE_AUTH_TOKEN:
19+
description: "Token for access to github package registry"
20+
required: true
21+
22+
runs:
23+
using: composite
24+
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
- uses: actions/setup-node@v4
29+
with:
30+
node-version: ${{ inputs.nodejs_version }}
31+
registry-url: 'https://npm.pkg.github.com'
32+
33+
- name: "Cache node_modules"
34+
uses: actions/cache@v4
35+
with:
36+
path: |
37+
**/node_modules
38+
key: ${{ runner.os }}-node-${{ inputs.nodejs_version }}-${{ hashFiles('**/package-lock.json') }}
39+
restore-keys: |
40+
${{ runner.os }}-node-${{ inputs.nodejs_version }}-
41+
42+
- name: Npm install
43+
working-directory: .
44+
env:
45+
NODE_AUTH_TOKEN: ${{ inputs.NODE_AUTH_TOKEN }}
46+
run: npm ci
47+
shell: bash
48+
49+
- name: Build ${{ inputs.apimEnv }} oas
50+
working-directory: .
51+
env:
52+
APIM_ENV: ${{ inputs.apimEnv }}
53+
shell: bash
54+
run: |
55+
if [ ${{ env.APIM_ENV }} == "internal-dev-sandbox" ] && [ ${{ inputs.buildSandbox }} == true ]
56+
then
57+
echo "Building sandbox OAS spec"
58+
make build-json-oas-spec APIM_ENV=sandbox
59+
else
60+
echo "Building env specific OAS spec"
61+
make build-yml-oas-spec APIM_ENV=${{ env.APIM_ENV }}
62+
fi
63+
64+
- name: Upload API OAS specification artifact
65+
uses: actions/upload-artifact@v4
66+
with:
67+
path: "build"
68+
name: api-oas-specification-${{ inputs.apimEnv }}${{ inputs.version != '' && format('-{0}', inputs.version) || '' }}

‎.github/actions/build-proxies/action.yml‎

Lines changed: 6 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -25,39 +25,16 @@ inputs:
2525
description: "Name of the Component to deploy"
2626
required: true
2727
default: 'api'
28-
nodejs_version:
29-
description: "Node.js version, set by the CI/CD pipeline workflow"
30-
required: true
31-
NODE_AUTH_TOKEN:
32-
description: "Token for access to github package registry"
33-
required: true
3428

3529
runs:
3630
using: composite
3731

3832
steps:
39-
- name: Checkout
40-
uses: actions/checkout@v4
41-
- uses: actions/setup-node@v4
42-
with:
43-
node-version: ${{ inputs.nodejs_version }}
44-
registry-url: 'https://npm.pkg.github.com'
45-
46-
- name: "Cache node_modules"
47-
uses: actions/cache@v4
33+
- name: Download OAS Spec artifact
34+
uses: actions/download-artifact@v4
4835
with:
49-
path: |
50-
**/node_modules
51-
key: ${{ runner.os }}-node-${{ inputs.nodejs_version }}-${{ hashFiles('**/package-lock.json') }}
52-
restore-keys: |
53-
${{ runner.os }}-node-${{ inputs.nodejs_version }}-
54-
55-
- name: Npm install
56-
working-directory: .
57-
env:
58-
NODE_AUTH_TOKEN: ${{ inputs.NODE_AUTH_TOKEN }}
59-
run: npm ci
60-
shell: bash
36+
name: api-oas-specification-${{ inputs.apimEnv }}${{ inputs.version != '' && format('-{0}', inputs.version) || '' }}
37+
path: ./build
6138

6239
- name: Setup Proxy Name and target
6340
shell: bash
@@ -87,21 +64,10 @@ runs:
8764
echo "MTLS_NAME=notify-supplier-mtls-pr$PR_NUMBER" >> $GITHUB_ENV
8865
fi
8966
90-
- name: Build ${{ inputs.apimEnv }} oas
91-
working-directory: .
92-
env:
93-
APIM_ENV: ${{ inputs.apimEnv }}
67+
- name: Set APIM_ENV
9468
shell: bash
9569
run: |
96-
if [ ${{ env.APIM_ENV }} == "internal-dev-sandbox" ] && [ ${{ inputs.buildSandbox }} == true ]
97-
then
98-
echo "Building sandbox OAS spec"
99-
make build-json-oas-spec APIM_ENV=sandbox
100-
else
101-
echo "Building env specific OAS spec"
102-
make build-json-oas-spec APIM_ENV=${{ env.APIM_ENV }}
103-
fi
104-
70+
APIM_ENV="${{ inputs.apimEnv }}"
10571
if [[ $APIM_ENV == *-pr ]]; then
10672
echo "Removing pr suffix from APIM_ENV after building OAS and calling proxygen"
10773
APIM_ENV=$(echo "$APIM_ENV" | sed 's/-pr$//')

‎.github/actions/build-sdk/action.yml‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,6 @@ runs:
5555
run: |
5656
make build VERSION="${{ inputs.version }}"
5757
58-
- name: Upload API OAS specification artifact
59-
uses: actions/upload-artifact@v4
60-
with:
61-
path: "build"
62-
name: api-oas-specification-${{ inputs.version }}
63-
6458
- name: Upload html artifact
6559
uses: actions/upload-artifact@v4
6660
with:

‎.github/workflows/manual-proxy-environment-deploy.yaml‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,13 @@ jobs:
7777
echo "ENVIRONMENT=$ENVIRONMENT" >> $GITHUB_ENV
7878
echo "APIM_ENV=$APIM_ENV" >> $GITHUB_ENV
7979
80+
- name: "Build OAS spec"
81+
uses: ./.github/actions/build-oas-spec
82+
with:
83+
apimEnv: "${{ env.APIM_ENV }}"
84+
buildSandbox: ${{ inputs.build_sandbox }}
85+
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
86+
8087
- name: "Build proxies"
8188
env:
8289
PROXYGEN_API_NAME: nhs-notify-supplier
@@ -90,4 +97,3 @@ jobs:
9097
runId: "${{ github.run_id }}"
9198
buildSandbox: ${{ inputs.build_sandbox }}
9299
releaseVersion: ${{ github.ref_name }}
93-
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/stage-3-build.yaml‎

Lines changed: 42 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,48 @@ jobs:
5555
version: "${{ inputs.version }}"
5656
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5757

58+
artefact-oas-spec:
59+
name: "Build OAS spec (${{ matrix.apimEnv }})"
60+
if: (github.event_name == 'push' && github.ref == 'refs/heads/main')
61+
runs-on: ubuntu-latest
62+
needs: [artefact-jekyll-docs]
63+
timeout-minutes: 10
64+
strategy:
65+
matrix:
66+
apimEnv: [internal-dev-pr, internal-dev, int, ref, prod]
67+
steps:
68+
- name: "Checkout code"
69+
uses: actions/checkout@v5
70+
- name: "Build OAS spec"
71+
uses: ./.github/actions/build-oas-spec
72+
with:
73+
version: "${{ inputs.version }}"
74+
apimEnv: "${{ matrix.apimEnv }}"
75+
buildSandbox: false
76+
nodejs_version: ${{ inputs.nodejs_version }}
77+
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
78+
79+
artefact-oas-spec-sandbox:
80+
name: "Build OAS spec for sandbox"
81+
runs-on: ubuntu-latest
82+
needs: [artefact-jekyll-docs]
83+
timeout-minutes: 10
84+
steps:
85+
- name: "Checkout code"
86+
uses: actions/checkout@v5
87+
- name: "Build proxies"
88+
uses: ./.github/actions/build-oas-spec
89+
with:
90+
version: "${{ inputs.version }}"
91+
apimEnv: "internal-dev-sandbox"
92+
buildSandbox: true
93+
nodejs_version: ${{ inputs.nodejs_version }}
94+
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
95+
5896
artefact-sdks:
5997
name: "Build SDKs"
6098
runs-on: ubuntu-latest
99+
needs: [artefact-oas-spec]
61100
timeout-minutes: 10
62101
steps:
63102
- name: "Checkout code"
@@ -94,6 +133,7 @@ jobs:
94133
pr-create-dynamic-environment:
95134
name: Create Dynamic Environment
96135
runs-on: ubuntu-latest
136+
if: inputs.pr_number != ''
97137
steps:
98138
- uses: actions/checkout@v5
99139
- name: Trigger dynamic environment creation
@@ -117,7 +157,8 @@ jobs:
117157
artefact-proxies:
118158
name: "Build proxies"
119159
runs-on: ubuntu-latest
120-
needs: [pr-create-dynamic-environment]
160+
if: inputs.pr_number != ''
161+
needs: [artefact-oas-spec-sandbox, pr-create-dynamic-environment]
121162
timeout-minutes: 10
122163
env:
123164
PROXYGEN_API_NAME: nhs-notify-supplier
@@ -136,5 +177,3 @@ jobs:
136177
runId: "${{ github.run_id }}"
137178
buildSandbox: true
138179
releaseVersion: ${{ github.head_ref || github.ref_name }}
139-
nodejs_version: ${{ inputs.nodejs_version }}
140-
NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.github/workflows/stage-5-publish.yaml‎

Lines changed: 36 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ jobs:
4040
name: "Publish packages"
4141
runs-on: ubuntu-latest
4242
timeout-minutes: 10
43+
outputs:
44+
release_id: ${{ steps.create_release.outputs.id }}
45+
upload_url: ${{ steps.create_release.outputs.upload_url }}
4346

4447
steps:
4548
- name: "Checkout code"
@@ -87,12 +90,6 @@ jobs:
8790
path: ./artifacts/sdk-csharp-${{ inputs.version }}
8891
name: sdk-csharp-${{ inputs.version }}
8992

90-
- name: "Get the artefacts 8"
91-
uses: actions/download-artifact@v6
92-
with:
93-
path: ./artifacts/api-oas-specification-${{ inputs.version }}
94-
name: api-oas-specification-${{ inputs.version }}
95-
9693
# Take out for now - might add again in the future
9794
# - name: "Get the artefacts 9"
9895
# uses: actions/download-artifact@v6
@@ -207,22 +204,6 @@ jobs:
207204
asset_name: sdk-csharp-${{ inputs.version }}.zip
208205
asset_content_type: "application/gzip"
209206

210-
- name: "zip api OAS specification release asset"
211-
# GitHub pages needs a single tar called artifact inside the zip.
212-
working-directory: ./artifacts/api-oas-specification-${{ inputs.version }}
213-
run: zip -r ../api-oas-specification-${{ inputs.version }}.zip .
214-
shell: bash
215-
216-
- name: "Upload api OAS specification release asset"
217-
uses: actions/upload-release-asset@v1
218-
env:
219-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
220-
with:
221-
upload_url: "${{ steps.create_release.outputs.upload_url }}"
222-
asset_path: ./artifacts/api-oas-specification-${{ inputs.version }}.zip
223-
asset_name: api-oas-specification-${{ inputs.version }}.zip
224-
asset_content_type: "application/gzip"
225-
226207
# Take out for now - might add again in the future
227208
# - name: "zip csharp server release asset"
228209
# # GitHub pages needs a single tar called artifact inside the zip.
@@ -241,6 +222,39 @@ jobs:
241222
# asset_name: server-csharp-${{ inputs.version }}.zip
242223
# asset_content_type: "application/gzip"
243224

225+
publish-oas-specs:
226+
name: "Publish OAS spec (${{ matrix.apimEnv }})"
227+
runs-on: ubuntu-latest
228+
needs: [publish]
229+
permissions:
230+
id-token: write # This is required for requesting the JWT
231+
contents: write # This is required for publishing release asset
232+
timeout-minutes: 10
233+
strategy:
234+
matrix:
235+
apimEnv: [internal-dev, int, ref, prod]
236+
steps:
237+
- name: "Download OAS spec artifact"
238+
uses: actions/download-artifact@v6
239+
with:
240+
path: ./artifacts/api-oas-specification-${{ matrix.apimEnv }}-${{ inputs.version }}
241+
name: api-oas-specification-${{ matrix.apimEnv }}-${{ inputs.version }}
242+
243+
- name: "Zip OAS specification"
244+
working-directory: ./artifacts/api-oas-specification-${{ matrix.apimEnv }}-${{ inputs.version }}
245+
run: zip -r ../api-oas-specification-${{ matrix.apimEnv }}-${{ inputs.version }}.zip .
246+
shell: bash
247+
248+
- name: "Upload OAS specification release asset"
249+
uses: actions/upload-release-asset@v1
250+
env:
251+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
252+
with:
253+
upload_url: ${{ needs.publish.outputs.upload_url }}
254+
asset_path: ./artifacts/api-oas-specification-${{ matrix.apimEnv }}-${{ inputs.version }}.zip
255+
asset_name: api-oas-specification-${{ matrix.apimEnv }}-${{ inputs.version }}.zip
256+
asset_content_type: "application/zip"
257+
244258
# Take out for now - might add again in the future
245259
# ### PUBLISH DOCKER - THIS NEEDS CHANGING TO DO THE DOCKER BUILD IN THE BUILD STAGE AND ARTIFACT IT. SEE publishlibhostdocker below how how and the buildlibs action.
246260
# publishdocker:

‎infrastructure/terraform/components/api/README.md‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ No requirements.
1212
| <a name="input_aws_account_id"></a> [aws\_account\_id](#input\_aws\_account\_id) | The AWS Account ID (numeric) | `string` | n/a | yes |
1313
| <a name="input_ca_pem_filename"></a> [ca\_pem\_filename](#input\_ca\_pem\_filename) | Filename for the CA truststore file within the s3 bucket | `string` | `null` | no |
1414
| <a name="input_component"></a> [component](#input\_component) | The variable encapsulating the name of this component | `string` | `"supapi"` | no |
15+
| <a name="input_core_account_id"></a> [core\_account\_id](#input\_core\_account\_id) | AWS Account ID for Core | `string` | `"000000000000"` | no |
16+
| <a name="input_core_environment"></a> [core\_environment](#input\_core\_environment) | Environment of Core | `string` | `"prod"` | no |
1517
| <a name="input_default_tags"></a> [default\_tags](#input\_default\_tags) | A map of default tags to apply to all taggable resources within the component | `map(string)` | `{}` | no |
1618
| <a name="input_enable_backups"></a> [enable\_backups](#input\_enable\_backups) | Enable backups | `bool` | `false` | no |
1719
| <a name="input_environment"></a> [environment](#input\_environment) | The name of the tfscaffold environment | `string` | n/a | yes |
@@ -34,26 +36,26 @@ No requirements.
3436

3537
| Name | Source | Version |
3638
|------|--------|---------|
37-
| <a name="module_authorizer_lambda"></a> [authorizer\_lambda](#module\_authorizer\_lambda) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip | n/a |
39+
| <a name="module_authorizer_lambda"></a> [authorizer\_lambda](#module\_authorizer\_lambda) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
3840
| <a name="module_domain_truststore"></a> [domain\_truststore](#module\_domain\_truststore) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-s3bucket.zip | n/a |
3941
| <a name="module_eventpub"></a> [eventpub](#module\_eventpub) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-eventpub.zip | n/a |
4042
| <a name="module_eventsub"></a> [eventsub](#module\_eventsub) | ../../modules/eventsub | n/a |
41-
| <a name="module_get_letter"></a> [get\_letter](#module\_get\_letter) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip | n/a |
42-
| <a name="module_get_letter_data"></a> [get\_letter\_data](#module\_get\_letter\_data) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip | n/a |
43-
| <a name="module_get_letters"></a> [get\_letters](#module\_get\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip | n/a |
44-
| <a name="module_get_status"></a> [get\_status](#module\_get\_status) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-lambda.zip | n/a |
43+
| <a name="module_get_letter"></a> [get\_letter](#module\_get\_letter) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
44+
| <a name="module_get_letter_data"></a> [get\_letter\_data](#module\_get\_letter\_data) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
45+
| <a name="module_get_letters"></a> [get\_letters](#module\_get\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
46+
| <a name="module_get_status"></a> [get\_status](#module\_get\_status) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
4547
| <a name="module_kms"></a> [kms](#module\_kms) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-kms.zip | n/a |
46-
| <a name="module_letter_status_update"></a> [letter\_status\_update](#module\_letter\_status\_update) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-lambda.zip | n/a |
48+
| <a name="module_letter_status_update"></a> [letter\_status\_update](#module\_letter\_status\_update) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
4749
| <a name="module_letter_status_updates_queue"></a> [letter\_status\_updates\_queue](#module\_letter\_status\_updates\_queue) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-sqs.zip | n/a |
48-
| <a name="module_letter_updates_transformer"></a> [letter\_updates\_transformer](#module\_letter\_updates\_transformer) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip | n/a |
50+
| <a name="module_letter_updates_transformer"></a> [letter\_updates\_transformer](#module\_letter\_updates\_transformer) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
4951
| <a name="module_logging_bucket"></a> [logging\_bucket](#module\_logging\_bucket) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-s3bucket.zip | n/a |
50-
| <a name="module_patch_letter"></a> [patch\_letter](#module\_patch\_letter) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip | n/a |
51-
| <a name="module_post_letters"></a> [post\_letters](#module\_post\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.24/terraform-lambda.zip | n/a |
52-
| <a name="module_post_mi"></a> [post\_mi](#module\_post\_mi) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip | n/a |
52+
| <a name="module_patch_letter"></a> [patch\_letter](#module\_patch\_letter) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
53+
| <a name="module_post_letters"></a> [post\_letters](#module\_post\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
54+
| <a name="module_post_mi"></a> [post\_mi](#module\_post\_mi) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
5355
| <a name="module_s3bucket_test_letters"></a> [s3bucket\_test\_letters](#module\_s3bucket\_test\_letters) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-s3bucket.zip | n/a |
5456
| <a name="module_sqs_letter_updates"></a> [sqs\_letter\_updates](#module\_sqs\_letter\_updates) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-sqs.zip | n/a |
5557
| <a name="module_supplier_ssl"></a> [supplier\_ssl](#module\_supplier\_ssl) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-ssl.zip | n/a |
56-
| <a name="module_upsert_letter"></a> [upsert\_letter](#module\_upsert\_letter) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.26/terraform-lambda.zip | n/a |
58+
| <a name="module_upsert_letter"></a> [upsert\_letter](#module\_upsert\_letter) | https://github.com/NHSDigital/nhs-notify-shared-modules/releases/download/v2.0.29/terraform-lambda.zip | n/a |
5759
## Outputs
5860

5961
| Name | Description |

0 commit comments

Comments
 (0)