File tree Expand file tree Collapse file tree 2 files changed +18
-1
lines changed
scripts/config/vale/styles/config/vocabularies/words Expand file tree Collapse file tree 2 files changed +18
-1
lines changed Original file line number Diff line number Diff line change @@ -22,6 +22,7 @@ This repository documents the Supplier API specification and provides an SDK wit
2222 - [ Documentation] ( #documentation )
2323 - [ Setup] ( #setup )
2424 - [ Prerequisites and Configuration] ( #prerequisites-and-configuration )
25+ - [ Build] ( #build )
2526 - [ Licence] ( #licence )
2627
2728## Documentation
@@ -33,7 +34,22 @@ This repository documents the Supplier API specification and provides an SDK wit
3334
3435### Prerequisites and Configuration
3536
36- Utilised the devcontainer, for pre reqs and configuration.
37+ - Utilised the devcontainer, for pre reqs and configuration.
38+ - You should open in a devcontainer or a Github workspaces.
39+ - By default it will run ` make config ` when the container is first setup
40+ - The [ SDK] ( sdk ) folder is excluded from all pre reqs
41+ - DO NOT make manual changes to the [ SDK] ( sdk ) , instead [ build] ( #build ) it
42+
43+ ## Build
44+
45+ To generate the SDK folder from changes to the [ specification/api/notify-supplier.yml] ( specification/api/notify-supplier.yml ) OAS specification:
46+
47+ ``` bash
48+ make clean
49+ make build
50+ ```
51+
52+ Currently these are include in Git. TODO: gitignore these and have the build pipeline generate artifacts that can be downloaded from GitHub.
3753
3854## Licence
3955
Original file line number Diff line number Diff line change 2222pre
2323Python
2424rawContent
25+ SDK
2526sed
2627Syft
2728Terraform
You can’t perform that action at this time.
0 commit comments