Skip to content

Commit

Permalink
[MOV-23365] docs: Improve Development and Vulnerabilities sections
Browse files Browse the repository at this point in the history
  • Loading branch information
thiagobraga committed Jan 11, 2025
1 parent 4564c50 commit c57352b
Showing 1 changed file with 19 additions and 14 deletions.
33 changes: 19 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ This is a Docker image created on top of [**php** official image](https://hub.do
- [Libs](#libs)
- [PHP Extensions](#php-extensions)
- [Quality Tools](#quality-tools)
- [Vulnerabilities](#vulnerabilities)
- [Development](#development)
- [Vulnerabilities](#vulnerabilities)

<!-- /TOC -->

Expand Down Expand Up @@ -164,27 +164,32 @@ FROM scaffoldeducation/php:<TAG>
<br>
## Vulnerabilities
The images are checked for vulnerabilities with `trivy`:
```sh
trivy image scaffoldeducation/php:8.0.30-dev --scanners vuln
## Development
scaffoldeducation/php:8.0.30-dev (alpine 3.16.7)
To include new features or fix some bugs, you can create a PR of your changes to this repository. You can test your changes locally with:
Total: 0 (UNKNOWN: 0, LOW: 0, MEDIUM: 0, HIGH: 0, CRITICAL: 0)
```sh
tests/pipeline.sh
```

<br>
in the root of the project. It'll run many build and test steps for each version. You can also run these scripts manually and independently. The pipeline script creates logs in `logs/pipeline.log` file.

## Development
<br>

To include new features or fix some bugs, you can create a PR of your changes to this repository. You can test your changes locally with:
## Vulnerabilities

The images are checked for vulnerabilities with `trivy` and `grype`:
```sh
tests/pipeline.sh
```
trivy image scaffoldeducation/php:8.2.27-prod --scanners vuln
2025-01-10T18:58:20-03:00 INFO [vuln] Vulnerability scanning is enabled
2025-01-10T18:58:20-03:00 INFO Detected OS family="alpine" version="3.21.2"
2025-01-10T18:58:20-03:00 WARN This OS version is not on the EOL list family="alpine" version="3.21"
2025-01-10T18:58:20-03:00 INFO [alpine] Detecting vulnerabilities... os_version="3.21" repository="3.21" pkg_num=140
2025-01-10T18:58:20-03:00 INFO Number of language-specific files num=0

scaffoldeducation/php:8.2.27-prod (alpine 3.21.2)

in the root of the project. It'll run many build and test steps for each version. This script creates logs in `pipeline.log` file at the root.
Total: 0 (UNKNOWN: 0, LOW: 0, MEDIUM: 0, HIGH: 0, CRITICAL: 0)
```

<br>

0 comments on commit c57352b

Please sign in to comment.