Skip to content

Commit 6b938de

Browse files
author
Sean Sundberg
authored
Updates readme and adds example bom (#3)
1 parent 7037ce9 commit 6b938de

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

.github/workflows/npm-publish.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,5 @@ jobs:
2323
npm install
2424
npm publish --access public
2525
env:
26+
NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
2627
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,22 @@
33
Library and CLI used to generate Infrastructure as Code installable components composed from a catalog of
44
modules.
55

6+
### CLI Usage
7+
8+
#### Installation
9+
10+
```shell
11+
npm i -g @cloudnativetoolkit/iascable
12+
```
13+
14+
#### Commands
15+
16+
```shell
17+
iascable build [-u {CATALOG_URL}] [-i {BOM_INPUT}] [--name {COMPONENT_NAME}]
18+
```
19+
20+
### API Usage
21+
622
### NPM scripts
723

824
- `npm t`: Run test suite

examples/bom.yaml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
apiVersion: cloud.ibm.com/v1alpha1
2+
kind: BillOfMaterial
3+
metadata:
4+
name: component
5+
spec:
6+
modules:
7+
- github.com/ibm-garage-cloud/terraform-k8s-ocp-cluster
8+
- github.com/ibm-garage-cloud/terraform-ibm-cp-app-connect
9+
variables: []

0 commit comments

Comments
 (0)