Skip to content

Commit 0440352

Browse files
docs: updating readme with fossa-test job description (#143)
1 parent f5b721c commit 0440352

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,15 +109,17 @@ fossa-scan
109109

110110
**Description:**
111111

112-
- This action scans a project for third party components and reports the results. This action checks license compliance and vulnerabilities. This file uses `.fossa.yml` configuration file
112+
- This action scans a project for third party components and creates report the with the results. This file job uses `.fossa.yml` configuration file
113+
114+
- Detected issues can be found in FOSSA app site https://app.fossa.com/. Link to direct report is generated per job and printed in logs
113115

114116
**Pass/fail behaviour:**
115117

116-
- This stage fails if FOSSA finds any license or security issues. Detected issues can be found in FOSSA app site https://app.fossa.com/. Link to direct report is generated per job and printed in logs. License issues should be checked by legal team, vulnerabilities should be solved by TA-dev or TA-qa team with assist of prodsec team if needed (some issues with critical status for example).
118+
- This stage fails if FOSSA cannot create report - for example some internal FOSSA error
117119

118120
**Troubleshooting steps for failures if any:**
119121

120-
- The error log is present in the stage as well user should be able to reproduce that in local environment with FOSSA CLI tool https://github.com/fossas/fossa-cli
122+
- The error log is present in the stage as well user should be able to run FOSSA in local environment with FOSSA CLI tool https://github.com/fossas/fossa-cli
121123

122124

123125
**Artifacts:**
@@ -126,6 +128,26 @@ fossa-scan
126128
THIRDPARTY
127129
```
128130
131+
fossa-test
132+
=======================
133+
134+
**Description:**
135+
136+
- This action checks report created in fossa-scan job. This action checks license compliance and vulnerabilities. This job uses `.fossa.yml` configuration file
137+
138+
**Pass/fail behaviour:**
139+
140+
- This stage fails if FOSSA finds any license or security issues. Detected issues can be found in FOSSA app site https://app.fossa.com/. Link to direct report is generated in fossa-scan job. License issues should be checked by legal team, vulnerabilities should be solved by TA-dev or TA-qa team with assist of prodsec team if needed (some issues with critical status for example).
141+
142+
**Troubleshooting steps for failures if any:**
143+
144+
- The error log is present in the stage as well user should be able to reproduce that in local environment with FOSSA CLI tool https://github.com/fossas/fossa-cli
145+
146+
**Artifacts:**
147+
148+
- No additional Artifacts.
149+
150+
129151
compliance-copyrights
130152
=====================
131153

0 commit comments

Comments
 (0)