Skip to content

Commit b7a57bc

Browse files
committed
update readme
1 parent 15c451c commit b7a57bc

File tree

2 files changed

+8
-14
lines changed

2 files changed

+8
-14
lines changed

.github/workflows/package_npm_code.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,6 @@ jobs:
6363
- uses: actions/upload-artifact@v4
6464
name: Upload packaged code
6565
with:
66-
name: NHSDigital-eps-cdk-constructs
66+
name: nhsdigital-eps-cdk-constructs-1.0.0.tgz
6767
path: |
68-
lib/NHSDigital-eps-cdk-constructs-1.0.0.tgz
68+
lib/nhsdigital-eps-cdk-constructs-1.0.0.tgz

README.md

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,15 @@ See [https://code.visualstudio.com/docs/devcontainers/containers](https://code.v
4040

4141
All commits must be made using [signed commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits).
4242

43-
### Setup
4443

45-
If you want to test a new construct, add it to `packages/cdkConstructs`.
44+
### Testing changes to construct library
45+
To test changes to the construct library, you need to package the library and install it on the project you want to test it on.
4646

47-
### Testing New Constructs
47+
Either
48+
- run `make package` from this project and copy the .tgz file from lib folder to the project you want to test in
49+
- create a pull request and from the pull request workflow run, download nhsdigital-eps-cdk-constructs-1.0.0.tgz to the project you want to test in
4850

49-
Run the following to produce a distributable tarball:
50-
51-
```bash
52-
make package
53-
```
54-
55-
This will produce a tarball file in the `lib` folder.
56-
57-
Copy this to the project you want to use it in and use the following to install it:
51+
In the project you want to test in, run the following
5852

5953
```bash
6054
npm install --save NHSDigital-eps-cdk-constructs-1.0.0.tgz --workspace packages/cdk/

0 commit comments

Comments
 (0)