Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 Adding repo documentation #23

Merged
merged 2 commits into from
Apr 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions .github/workflows/anchore.yml

This file was deleted.

51 changes: 0 additions & 51 deletions .github/workflows/endorlabs.yml

This file was deleted.

74 changes: 0 additions & 74 deletions .github/workflows/frogbot-scan-pr.yml

This file was deleted.

56 changes: 0 additions & 56 deletions .github/workflows/ossar.yml

This file was deleted.

4 changes: 2 additions & 2 deletions .github/workflows/pmd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up JDK 21
- name: Set up JDK 22
uses: actions/setup-java@v3
with:
java-version: '21'
java-version: '22'
distribution: 'temurin'
- name: Run PMD
id: pmd
Expand Down
69 changes: 69 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
Se trata de un repositorio creado para ejercitar contenidos del curso De
DevOps a DevSecOps: seguridad en los procesos da [IEBS](https://www.iebschool.com/).

El proyecto en sí es una implementación API-First que utiliza Java,
Springboot y Gradle. A través de una especificación OpenAPI, se genera una interfaz
Java para que los controladores creados estén alineados con la especificación API
propuesta en la carpeta **build**.

```
.
├── build
│ └── generate-resources
│ └── main
│ ├── pom.xml
│ ├── README.md
│ └── src
│ └── main
│ └── java
│ └── org
│ └── openapitools
│ ├── api
│ │ ├── ApiUtil.java
│ │ └── BatidasApi.java
│ └── model
│ ├── Mensagem.java
│ └── Momento.java
├── build.gradle.kts
├── gradle
│ └── wrapper
├── gradle.properties
├── gradlew
├── gradlew.bat
├── plugins
│ ├── java.gradle
│ └── openapi.gradle
├── README.md
├── settings.gradle.kts
└── src
├── main
│ ├── java
│ │ └── com
│ │ └── arthurfnsc
│ │ └── apifirst
│ │ ├── ApiFirstApplication.java
│ │ └── rest
│ │ └── FolhaPontoController.java
│ └── resources
│ ├── application.properties
│ └── openapi
│ └── folha_ponto-api.yaml
└── test
└── java
```

Para generar la interfaz, ejecute el siguiente comando:

```
./gradlew clean compileJava
```

Aunque el curso está dirigido a los pasos de DevSecOps, no tengo la experiencia para
definir el mejor enfoque para las herramientas SAST, DAST y definir el sombreado entre
opciones, por lo que agregué varias GithubActions para validar algunos conceptos en la
pipeline.

En el futuro, el repositorio puede sufrir cambios no necesariamente relacionados con la
parte de seguridad, pero la pipeline de CI/CD y el contexto de seguridad permanecerán.
Debido a que agregaste varias GithubActions en confirmaciones futuras, es posible que
algunas de ellas se modifiquen sean eliminadas.
Loading