@defra/grants-config-utils 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/release.yml +8 -0
- package/CHANGELOG.md +6 -0
- package/CONTRIBUTING.md +2 -3
- package/README.md +13 -0
- package/package.json +1 -1
|
@@ -5,6 +5,11 @@ on:
|
|
|
5
5
|
branches:
|
|
6
6
|
- main
|
|
7
7
|
workflow_dispatch:
|
|
8
|
+
inputs:
|
|
9
|
+
commit_message:
|
|
10
|
+
description: 'commit message'
|
|
11
|
+
required: false
|
|
12
|
+
type: string
|
|
8
13
|
|
|
9
14
|
permissions:
|
|
10
15
|
contents: write
|
|
@@ -97,6 +102,9 @@ jobs:
|
|
|
97
102
|
ref: 'main',
|
|
98
103
|
headers: {
|
|
99
104
|
'X-GitHub-Api-Version': '2022-11-28'
|
|
105
|
+
},
|
|
106
|
+
inputs: {
|
|
107
|
+
commit_message: 'Create new config version'
|
|
100
108
|
}
|
|
101
109
|
});
|
|
102
110
|
|
package/CHANGELOG.md
CHANGED
package/CONTRIBUTING.md
CHANGED
|
@@ -19,6 +19,5 @@ To make changes to this library, please follow the steps below:
|
|
|
19
19
|
4. Push to branch, and create a pull request.
|
|
20
20
|
5. Github actions will verify the build
|
|
21
21
|
6. After review, merge the pull request.
|
|
22
|
-
7. A second PR will be created by the release action.
|
|
23
|
-
8.
|
|
24
|
-
9. Github actions will automatically increment the version and publish to NPM.
|
|
22
|
+
7. A second PR will be created and auto-merged by the release action.
|
|
23
|
+
8. Github actions will automatically increment the version and publish to NPM.
|
package/README.md
CHANGED
|
@@ -15,6 +15,19 @@ npm install --save @defra/grants-config-utils
|
|
|
15
15
|
|
|
16
16
|
Refer to the [contributing documentation](CONTRIBUTING.md).
|
|
17
17
|
|
|
18
|
+
## Environment Variables
|
|
19
|
+
|
|
20
|
+
The following variables are used in this module:
|
|
21
|
+
|
|
22
|
+
- `SERVICE_VERSION` - **Required** This is the CDP service version that should be injected automatically in all consuming services
|
|
23
|
+
- `AWS_REGION` - **Required** Region where the service is deployed
|
|
24
|
+
- `CONFIG_BUCKET_NAME` - **Required** The S3 bucket where the config is to be stored
|
|
25
|
+
- `FORCE_PATH_STYLE` - Optional flag to force path style URLs when using S3 bucket (default true)
|
|
26
|
+
- `AWS_ENDPOINT_URL` - Optional AWS endpoint URL for local development
|
|
27
|
+
- `GRANTS_CONFIG_BROKER_AUTH_TOKEN` - **Required** Auth token for the grants config broker API
|
|
28
|
+
- `GRANTS_CONFIG_BROKER_ENCRYPTION_KEY` - **Required** Encryption key for the grants config broker API
|
|
29
|
+
- `GRANTS_CONFIG_BROKER_API_ENDPOINT` - **Required** Endpoint for the grants config broker API
|
|
30
|
+
|
|
18
31
|
## Licence
|
|
19
32
|
|
|
20
33
|
THIS INFORMATION IS LICENSED UNDER THE CONDITIONS OF THE OPEN GOVERNMENT LICENCE found at:
|