Skip to content

Commit 26a98ef

Browse files
committed
Merge branch 'smitronin-feat/ui-docs-update' into 'master'
feat(ui): readme update See merge request postgres-ai/database-lab!473
2 parents 65febde + 2c0399a commit 26a98ef

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

ui/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,20 @@ git tag ui/1.0.12
4343
git push origin ui/1.0.12
4444
```
4545

46-
<!-- TODO: move this ^ to the main README.md and CONTRIBUTING.md -->
46+
## Vulnerability issues
47+
Vulnerabilities, CVEs, security issues can be reported on GitLab or on GitHub by various tools/bots we use to ensure that DLE code is safe and secure. They may be of various kinds – here we consider two types, a known CVE reported for particular package we use for DLE UI code during analysis of dependencies, and some issue in code that was detected by a static analysis tool.
48+
49+
### Packages issues
50+
Ways to resolve (ordered by preference in descending order):
51+
1. Update a package - try to look for a newer package in npm, probably this vulnerability is already fixed.
52+
2. If vulnerability is detected in a sub-package - try to replace it using [npm-force-resolutions](https://www.npmjs.com/package/npm-force-resolutions). Be careful using this way - it may break a project as in a build phase as at runtime. Full e2e definitely should be done in this case.
53+
3. Fork the package and put it locally in this repo.
54+
4. If you are sure this is a falsy vulnerability - try to ignore it using special commands for your SAST tool. **This is considered as the least preferable option – try to apply any of the ways described above first.**
55+
56+
### Code issues
57+
Ways to resolve (ordered by preference):
58+
1. If the part of source code is written on `.js` try to rewrite it on `.ts` or `.tsx` - it should fix a lot of potential security issues.
59+
2. Follow the recommendations of your SAST tool - fix it manually or automatically.
60+
3. If you are sure this is a falsy vulnerability - try to ignore it using special commands for your SAST tool. **This is considered as the least preferable option – try to apply any of the ways described above first.**
61+
62+
<!-- TODO: move this ^ to the main README.md and CONTRIBUTING.md -->

ui/cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,7 @@
137137
"craco",
138138
"Formik",
139139
"healthz",
140+
"SAST",
140141
"rehype"
141142
]
142143
}

0 commit comments

Comments
 (0)