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 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 ] 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