Skip to content

Commit e0c0dad

Browse files
Update readme.
1 parent a48bef6 commit e0c0dad

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ This repository documents the Supplier API specification and provides an SDK wit
2323
- [Setup](#setup)
2424
- [Prerequisites and Configuration](#prerequisites-and-configuration)
2525
- [Build](#build)
26+
- [GitHub Actions CI/CD](#github-actions-cicd)
27+
- [CI (Automatic)](#ci-automatic)
28+
- [CD (Manual)](#cd-manual)
2629
- [Licence](#licence)
2730

2831
## Documentation
@@ -68,6 +71,24 @@ by default they will be available at [http://localhost:3050](http://localhost:30
6871

6972
These are generated using [https://hub.docker.com/r/openapitools/openapi-generator-cli](https://hub.docker.com/r/openapitools/openapi-generator-cli)
7073

74+
## GitHub Actions CI/CD
75+
76+
### CI (Automatic)
77+
78+
PRs will run the [CI workflow](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-1-pull-request.yaml)
79+
for testing.
80+
81+
PRs that are merged to main will run the same [CI workflow](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-1-pull-request.yaml)
82+
will generate a
83+
[pre-release](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
84+
based on the date and the commit hash.
85+
86+
### CD (Manual)
87+
88+
Deployments can be made of any [release](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
89+
(including the GitHub pages) by running the CD pipeline
90+
[cicd-3-deploy.yaml](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-3-deploy.yaml)
91+
7192
## Licence
7293

7394
Unless stated otherwise, the codebase is released under the MIT License. This covers both the codebase and any sample code in the documentation.

0 commit comments

Comments
 (0)