From 1d7a5d10974ad4480875210cf877420c514b7995 Mon Sep 17 00:00:00 2001 From: Nano Taboada Date: Fri, 18 Apr 2025 15:56:18 -0300 Subject: [PATCH 1/3] chore(ci): switch to default setup for CodeQL scanning --- .github/workflows/codacy.yml | 49 ------------------------------------ 1 file changed, 49 deletions(-) delete mode 100644 .github/workflows/codacy.yml diff --git a/.github/workflows/codacy.yml b/.github/workflows/codacy.yml deleted file mode 100644 index 87b61ea..0000000 --- a/.github/workflows/codacy.yml +++ /dev/null @@ -1,49 +0,0 @@ -# This workflow uses actions not certified by GitHub. They are provided by a -# third-party and governed by separate terms of service, privacy policy, and -# support documentation. This workflow checks out code, performs a Codacy -# security scan, and integrates the results with GitHub Advanced Security code -# scanning feature. For more info on the Codacy Security Scan action usage and -# parameters, see: https://github.com/codacy/codacy-analysis-cli-action. -# For more info on Codacy Analysis CLI in general, see: -# https://github.com/codacy/codacy-analysis-cli. - -name: Codacy Security Scan - -on: - push: - branches: [ "master" ] - pull_request: - branches: [ "master" ] - schedule: - - cron: '0 21 * * 5' # Runs at 21:00, only on Friday - -permissions: - contents: read - -jobs: - codacy-security-scan: - permissions: - contents: read - security-events: write - actions: read - name: Codacy Security Scan - runs-on: ubuntu-latest - steps: - - name: Checkout code - uses: actions/checkout@v4 - # Execute Codacy Analysis CLI and generate a SARIF output with the security - # issues identified during the analysis - - name: Run Codacy Analysis CLI - uses: codacy/codacy-analysis-cli-action@master - with: - project-token: ${{ secrets.CODACY_PROJECT_TOKEN }} - verbose: true - output: results.sarif - format: sarif - gh-code-scanning-compat: true - max-allowed-issues: 2147483647 - # Upload the SARIF file generated in the previous step - - name: Upload SARIF results file - uses: github/codeql-action/upload-sarif@v3 - with: - sarif_file: results.sarif From a2892355b6ceb6dd31eef2428186c07f00f8d3e4 Mon Sep 17 00:00:00 2001 From: Nano Taboada Date: Fri, 18 Apr 2025 15:57:24 -0300 Subject: [PATCH 2/3] chore: update structure diagram --- README.md | 8 ++++---- assets/images/structure.svg | 1 + .../images/swagger.png | Bin java.samples.spring.boot.svg | 1 - 4 files changed, 5 insertions(+), 5 deletions(-) create mode 100644 assets/images/structure.svg rename java.samples.spring.boot-swagger.png => assets/images/swagger.png (100%) delete mode 100644 java.samples.spring.boot.svg diff --git a/README.md b/README.md index b4fa546..e12e777 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ ## Manifesto -> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — Linus Torvalds +> "Nobody should start to undertake a large project. You start with a small _trivial_ project, and you should never expect it to get large. If you do, you'll just overdesign and generally think it is more important than it likely is at that stage. Or worse, you might be scared away by the sheer size of the work you envision. So start small, and think about the details. Don't think about some big picture and fancy design. If it doesn't solve some fairly immediate need, it's almost certainly over-designed. And don't expect people to jump in and help you. That's not how these things work. You need to get something half-way _useful_ first, and then others will say "hey, that _almost_ works for me", and they'll get involved in the project." — [Linus Torvalds](https://web.archive.org/web/20050404020308/http://www.linuxtimes.net/modules.php?name=News&file=article&sid=145) ## About @@ -19,9 +19,9 @@ Proof of Concept for a RESTful Web Service made with [Spring Boot 3](https://spr ## Structure -The following is a simplified dependency diagram of modules and main libraries: +![Simplified, conceptual project structure and main application flow](assets/images/structure.svg) -![Dependency Diagram](java.samples.spring.boot.svg) +_Figure: Simplified, conceptual project structure and main application flow. Not all dependencies are shown._ ## Documentation @@ -29,7 +29,7 @@ The following is a simplified dependency diagram of modules and main libraries: http://localhost:9000/swagger/index.html ``` -![API Documentation](java.samples.spring.boot-swagger.png) +![API Documentation](assets/images/swagger.png) ## Credits diff --git a/assets/images/structure.svg b/assets/images/structure.svg new file mode 100644 index 0000000..ebac742 --- /dev/null +++ b/assets/images/structure.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/java.samples.spring.boot-swagger.png b/assets/images/swagger.png similarity index 100% rename from java.samples.spring.boot-swagger.png rename to assets/images/swagger.png diff --git a/java.samples.spring.boot.svg b/java.samples.spring.boot.svg deleted file mode 100644 index 64b8746..0000000 --- a/java.samples.spring.boot.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file From b9bde07c9aadc23e91dbdc9b24f85c5d9d06af1f Mon Sep 17 00:00:00 2001 From: Nano Taboada Date: Fri, 18 Apr 2025 15:58:03 -0300 Subject: [PATCH 3/3] fix(ci): set workflow permissions (contents: read) --- .github/workflows/maven.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 85c934d..f67cca5 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -3,6 +3,9 @@ name: Java CI +permissions: + contents: read + on: push: branches: [ master ]