Adding necessary confs for SonarCloud (#1)

* Adding necessary confs for sonarCloud * Update README.md
Arquisoft · Jan 22, 2024 · dc29907 · dc29907
1 parent febcecc
commit dc29907
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 19 deletions.
diff --git a/.env b/.env
@@ -1 +1 @@
-teamname="wiq_0"
+teamname="wiq_es05c"
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -53,7 +53,7 @@ jobs:
       env:
         API_URI: http://${{ secrets.DEPLOY_HOST }}:8000
       with:
-          name: arquisoft/wiq_0/webapp
+          name: arquisoft/wiq_es05c/webapp
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
           registry: ghcr.io
@@ -71,7 +71,7 @@ jobs:
     - name: Publish to Registry
       uses: elgohr/Publish-Docker-Github-Action@v5
       with:
-          name: arquisoft/wiq_0/authservice
+          name: arquisoft/wiq_es05c/authservice
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
           registry: ghcr.io
@@ -88,7 +88,7 @@ jobs:
     - name: Publish to Registry
       uses: elgohr/Publish-Docker-Github-Action@v5
       with:
-        name: arquisoft/wiq_0/userservice
+        name: arquisoft/wiq_es05c/userservice
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
         registry: ghcr.io
@@ -105,7 +105,7 @@ jobs:
     - name: Publish to Registry
       uses: elgohr/Publish-Docker-Github-Action@v5
       with:
-        name: arquisoft/wiq_0/gatewayservice
+        name: arquisoft/wiq_es05c/gatewayservice
         username: ${{ github.actor }}
         password: ${{ secrets.GITHUB_TOKEN }}
         registry: ghcr.io
@@ -122,7 +122,6 @@ jobs:
         user: ${{ secrets.DEPLOY_USER }}
         key: ${{ secrets.DEPLOY_KEY }}
         command: |
-          wget https://raw.githubusercontent.com/arquisoft/wiq_0/master/docker-compose.yml
-          wget https://raw.githubusercontent.com/arquisoft/wiq_0/master/docker-compose-deploy.override.yml
+          wget https://raw.githubusercontent.com/arquisoft/wiq_es05c/master/docker-compose.yml
           docker compose down
           docker compose --profile prod up -d
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
-# wiq_0
+# wiq_es05c
 
-[![Deploy on release](https://github.com/Arquisoft/wiq_0/actions/workflows/release.yml/badge.svg)](https://github.com/Arquisoft/wiq_0/actions/workflows/release.yml)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wiq_0&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wiq_0)
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wiq_0&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wiq_0)
+[![Deploy on release](https://github.com/Arquisoft/wiq_es05c/actions/workflows/release.yml/badge.svg)](https://github.com/Arquisoft/wiq_es05c/actions/workflows/release.yml)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wiq_es05c&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wiq_es05c)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wiq_es05c&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wiq_es05c)
 
 This is a base repo for the [Software Architecture course](http://arquisoft.github.io/) in [2023/2024 edition](https://arquisoft.github.io/course2324.html). 
 
@@ -22,7 +22,7 @@ Both the user and auth service share a Mongo database that is accessed with mong
 The fastest way for launching this sample project is using docker. Just clone the project:
 
 ```sh
-git clone https://github.com/Arquisoft/wiq_0.git
+git clone https://github.com/Arquisoft/wiq_es05c.git
 ```
 
 and launch it with docker compose:
@@ -100,7 +100,7 @@ deploy:
         user: ${{ secrets.DEPLOY_USER }}
         key: ${{ secrets.DEPLOY_KEY }}
         command: |
-          wget https://raw.githubusercontent.com/arquisoft/wiq_0/master/docker-compose-deploy.yml -O docker-compose.yml
+          wget https://raw.githubusercontent.com/arquisoft/wiq_es05c/master/docker-compose-deploy.yml -O docker-compose.yml
           docker compose down --volumes
           docker compose --profile prod up -d
 ```

diff --git a/docs/README.md b/docs/README.md
@@ -1,6 +1,6 @@
 ## The documentation
 In this project, the documentation is compiled locally and deployed to GitHub pages.
-The deployment url is: [https://arquisoft.github.io/wiq_0/](https://arquisoft.github.io/wiq_0/).
+The deployment url is: [https://arquisoft.github.io/wiq_es05c/](https://arquisoft.github.io/wiq_es05c/).
 
 ### Documentation build
 For the documentation, we are going to use [AsciiDoc](https://asciidoc.org/) and [PlantUML](https://plantuml.com) and follow the [Arc42](https://github.com/arc42/arc42-template) template. If you want to be able to generate the doc locally you need to install Ruby, Java and some dependencies to translate the AsciiDoc code into html. If you are in Linux you can install Ruby and Java simply by executing:
@@ -30,6 +30,6 @@ npm run build
 The documentation will be generated under the `docs/build` directory. 
 
 ### Documentation deployment
-If we want to deploy it to GitHub pages, so it is accessible via [https://arquisoft.github.io/wiq_0/](https://arquisoft.github.io/wiq_0/), we need to execute `npm run deploy`.
+If we want to deploy it to GitHub pages, so it is accessible via [https://arquisoft.github.io/wiq_es05c/](https://arquisoft.github.io/wiq_es05c/), we need to execute `npm run deploy`.
 
-If you check the `package.json` in this directory you can see how deploying is as easy as executing `gh-pages -d build`, which can be directly executed using `npm run deploy` in the docs directory. The `gh-pages` package is in charge of pushing the documentation generated directory (basically some htmls) to a special github branch called gh-pages. Everything pushed to this branch is accessible on the repository page. Note that we only want to push there the documentation. Also is important that the documentation build is not pushed to the other branches of the project.
+If you check the `package.json` in this directory you can see how deploying is as easy as executing `gh-pages -d build`, which can be directly executed using `npm run deploy` in the docs directory. The `gh-pages` package is in charge of pushing the documentation generated directory (basically some htmls) to a special github branch called gh-pages. Everything pushed to this branch is accessible on the repository page. Note that we only want to push there the documentation. Also is important that the documentation build is not pushed to the other branches of the project.
diff --git a/sonar-project.properties b/sonar-project.properties
@@ -1,14 +1,14 @@
-sonar.projectKey=Arquisoft_wiq_0
+sonar.projectKey=Arquisoft_wiq_es05c
 sonar.organization=arquisoft
 
 # This is the name and version displayed in the SonarCloud UI.
-sonar.projectName=wiq_0
+sonar.projectName=wiq_es05c
 sonar.projectVersion=1.0
 
 # Encoding of the source code. Default is default system encoding
 sonar.host.url=https://sonarcloud.io
 sonar.language=js
-sonar.projectName=wiq_0
+sonar.projectName=wiq_es05c
 
 sonar.coverage.exclusions=**/*.test.js
 sonar.sources=webapp/src/components,users/authservice,users/userservice,gatewayservice