Skip to content

Commit 00ecc90

Browse files
committed
docs: Corrected the variables and code snippets
The examples in the readme file had variables in camelCase while in the code they are all smallcase. I modified the readme to match the code, so now a user can copy paste the code from the readme and have a working example directly. Signed-off-by: Diamantis Sellis <diamantis.sellis@cosmotech.com>
1 parent 48feab3 commit 00ecc90

1 file changed

Lines changed: 40 additions & 40 deletions

File tree

README.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This action uploads a software bill of materials file to a Dependency-Track serv
44

55
## Inputs
66

7-
### `serverHostname`
7+
### `serverhostname`
88

99
**Required** Dependency-Track hostname
1010

@@ -18,43 +18,43 @@ Can be `https` or `http`
1818

1919
Defaults to `https`
2020

21-
### `apiKey`
21+
### `apikey`
2222

2323
**Required** Dependency-Track API key
2424

2525
### `project`
2626

2727
**Required, unless projectName and projectVersion are provided** Project uuid in Dependency-Track
2828

29-
### `projectName`
29+
### `projectname`
3030

3131
**Required, unless project is provided** Project name in Dependency-Track
3232

33-
### `projectVersion`
33+
### `projectversion`
3434

3535
**Required, unless project is provided** Project version in Dependency-Track
3636

37-
### `projectTags`
37+
### `projecttags`
3838

3939
Comma-separated list of tags (available in DT v4.12 and later)
4040

41-
### `autoCreate`
41+
### `autocreate`
4242

4343
Automatically create project and version in Dependency-Track, default `false`
4444

45-
### `bomFilename`
45+
### `bomfilename`
4646

4747
Path and filename of the BOM, default `bom.xml`
4848

4949
### `parent`
5050

5151
Parent project uuid in Dependency-Track (available in DT v4.8 and later)
5252

53-
### `parentName`
53+
### `parentname`
5454

5555
**parentVersion is also required** Parent project name in Dependency-Track (available in DT v4.8 and later)
5656

57-
### `parentVersion`
57+
### `parentversion`
5858

5959
**parentName is also required** Parent project version in Dependency-Track (available in DT v4.8 and later)
6060

@@ -64,47 +64,47 @@ With project name and version:
6464
```yml
6565
uses: DependencyTrack/gh-upload-sbom@v3
6666
with:
67-
serverHostname: 'example.com'
68-
apiKey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
69-
projectName: 'Example Project'
70-
projectVersion: 'master'
71-
bomFilename: "/path/to/bom.xml"
72-
autoCreate: true
67+
serverhostname: 'example.com'
68+
apikey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
69+
projectname: 'Example Project'
70+
projectversion: 'master'
71+
bomfilename: "/path/to/bom.xml"
72+
autocreate: true
7373
```
7474
7575
With project name, version and tags:
7676
```yml
7777
uses: DependencyTrack/gh-upload-sbom@v3
7878
with:
79-
serverHostname: 'example.com'
80-
apiKey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
81-
projectName: 'Example Project'
82-
projectVersion: 'master'
83-
projectTags: 'tag1,tag2'
84-
bomFilename: "/path/to/bom.xml"
85-
autoCreate: true
79+
serverhostname: 'example.com'
80+
apikey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
81+
projectname: 'Example Project'
82+
projectversion: 'master'
83+
projecttags: 'tag1,tag2'
84+
bomfilename: "/path/to/bom.xml"
85+
autocreate: true
8686
```
8787
8888
With protocol, port and project name:
8989
```yml
9090
uses: DependencyTrack/gh-upload-sbom@v3
9191
with:
9292
protocol: ${{ secrets.DEPENDENCYTRACK_PROTOCOL }}
93-
serverHostname: ${{ secrets.DEPENDENCYTRACK_HOSTNAME }}
93+
serverhostname: ${{ secrets.DEPENDENCYTRACK_HOSTNAME }}
9494
port: ${{ secrets.DEPENDENCYTRACK_PORT }}
95-
apiKey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
96-
projectName: 'Example Project'
97-
projectVersion: 'master'
98-
bomFilename: "/path/to/bom.xml"
99-
autoCreate: true
95+
apikey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
96+
projectname: 'Example Project'
97+
projectversion: 'master'
98+
bomfilename: "/path/to/bom.xml"
99+
autocreate: true
100100
```
101101
102102
With project uuid:
103103
```yml
104104
uses: DependencyTrack/gh-upload-sbom@v3
105105
with:
106-
serverHostname: 'example.com'
107-
apiKey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
106+
serverhostname: 'example.com'
107+
apikey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
108108
project: 'dadec8ad-7053-4e8c-8044-7b6ef698e08d'
109109
```
110110
@@ -113,23 +113,23 @@ With protocol, port, project name and parent name:
113113
uses: DependencyTrack/gh-upload-sbom@v3
114114
with:
115115
protocol: ${{ secrets.DEPENDENCYTRACK_PROTOCOL }}
116-
serverHostname: ${{ secrets.DEPENDENCYTRACK_HOSTNAME }}
116+
serverhostname: ${{ secrets.DEPENDENCYTRACK_HOSTNAME }}
117117
port: ${{ secrets.DEPENDENCYTRACK_PORT }}
118-
apiKey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
119-
projectName: 'Example Project'
120-
projectVersion: 'master'
121-
bomFilename: "/path/to/bom.xml"
122-
autoCreate: true
123-
parentName: 'Example Parent'
124-
parentVersion: 'master'
118+
apikey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
119+
projectname: 'Example Project'
120+
projectversion: 'master'
121+
bomfilename: "/path/to/bom.xml"
122+
autocreate: true
123+
parentname: 'Example Parent'
124+
parentversion: 'master'
125125
```
126126
127127
With parent uuid:
128128
```yml
129129
uses: DependencyTrack/gh-upload-sbom@v3
130130
with:
131-
serverHostname: 'example.com'
132-
apiKey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
131+
serverhostname: 'example.com'
132+
apikey: ${{ secrets.DEPENDENCYTRACK_APIKEY }}
133133
project: 'dadec8ad-7053-4e8c-8044-7b6ef698e08d'
134134
parent: '6a5a3c33-3f8b-42ee-8d50-594bfd95dd32'
135135
```

0 commit comments

Comments
 (0)