valitydev/java-workflow
14
0
Fork 0
mirror of https://github.com/valitydev/java-workflow.git synced 2024-11-06 01:25:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

added a description for the tool - semgrep

Browse Source
This commit is contained in:
St-Ilya 2024-06-07 12:45:33 +03:00
parent 5e516480a1
commit 7e9689043d
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,10 +7,16 @@
- Library - собираем библиотеку и деплоим в maven central - Library - собираем библиотеку и деплоим в maven central
- Swag - собираем openapi, деплоим в maven central и публикуем в github pages - Swag - собираем openapi, деплоим в maven central и публикуем в github pages
Инструменты для сканирование:
- Semgrep - сканирует по дефолтным правилам и выводит отчет в формате Sarif
Чтобы начать использовать java-workflow в своем репозитории - добавьте в директорию `/.github/workflows/` файлы Чтобы начать использовать java-workflow в своем репозитории - добавьте в директорию `/.github/workflows/` файлы
`build.yml` и `deploy.yml`, файлов описания workflow не обязательно должно быть два, вы можете самостоятельно описать workflow с использованием `java-workflow`. `build.yml` и `deploy.yml`, файлов описания workflow не обязательно должно быть два, вы можете самостоятельно описать workflow с использованием `java-workflow`.
Ниже приведен пример для `service` типа проекта. Аналогично и для других типов, изменяется только название файла и передаваемые параметры. Ниже приведен пример для `service` типа проекта. Аналогично и для других типов, изменяется только название файла и передаваемые параметры.
Для сканирования проектов - инструмент Semgrep.
Чтобы начать использовать - добавьте в директорию файл `semgrep-scan.yml`
`build.yml` `build.yml`
```yaml ```yaml
name: Build Maven Artifact name: Build Maven Artifact
@ -103,3 +109,9 @@ secrets:
github-token: ${{ secrets.GITHUB_TOKEN }} github-token: ${{ secrets.GITHUB_TOKEN }}
mm-webhook-url: ${{ secrets.MATTERMOST_WEBHOOK_URL }} mm-webhook-url: ${{ secrets.MATTERMOST_WEBHOOK_URL }}
``` ```
### Semgrep scan
`semgrep-scan.yml`
```yaml
uses: valitydev/java-workflow/.github/workflows/semgrep-scan.yml@sec-24
```