From 17190081d777b913aed3676f73180e8550f9eeda Mon Sep 17 00:00:00 2001 From: pglez82 Date: Mon, 20 Jan 2025 12:04:45 +0100 Subject: [PATCH] Customize repository --- .github/workflows/release.yml | 14 +++++++------- README.md | 12 ++++++------ docker-compose.yml | 26 +++++++++++++------------- docs/README.md | 4 ++-- docs/index.adoc | 2 +- gatewayservice/package.json | 6 +++--- llmservice/package.json | 2 +- sonar-project.properties | 4 ++-- users/authservice/package.json | 6 +++--- users/userservice/package.json | 6 +++--- webapp/public/index.html | 2 +- 11 files changed, 42 insertions(+), 42 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 4c93e31e..5be3799e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -1,4 +1,4 @@ -name: CI for wichat_0 +name: CI for wichat_es5b on: release: @@ -56,7 +56,7 @@ jobs: API_URI: http://${{ secrets.DEPLOY_HOST }}:8000 LLM_API_KEY: ${{ secrets.LLM_API_KEY }} with: - name: arquisoft/wichat_0/webapp + name: arquisoft/wichat_es5b/webapp username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} registry: ghcr.io @@ -76,7 +76,7 @@ jobs: - name: Publish to Registry uses: elgohr/Publish-Docker-Github-Action@v5 with: - name: arquisoft/wichat_0/authservice + name: arquisoft/wichat_es5b/authservice username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} registry: ghcr.io @@ -95,7 +95,7 @@ jobs: - name: Publish to Registry uses: elgohr/Publish-Docker-Github-Action@v5 with: - name: arquisoft/wichat_0/userservice + name: arquisoft/wichat_es5b/userservice username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} registry: ghcr.io @@ -113,7 +113,7 @@ jobs: - name: Publish to Registry uses: elgohr/Publish-Docker-Github-Action@v5 with: - name: arquisoft/wichat_0/llmservice + name: arquisoft/wichat_es5b/llmservice username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} registry: ghcr.io @@ -135,7 +135,7 @@ jobs: - name: Publish to Registry uses: elgohr/Publish-Docker-Github-Action@v5 with: - name: arquisoft/wichat_0/gatewayservice + name: arquisoft/wichat_es5b/gatewayservice username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} registry: ghcr.io @@ -152,6 +152,6 @@ jobs: # user: ${{ secrets.DEPLOY_USER }} # key: ${{ secrets.DEPLOY_KEY }} # command: | - # wget https://raw.githubusercontent.com/arquisoft/wichat_0/master/docker-compose.yml -O docker-compose.yml + # wget https://raw.githubusercontent.com/arquisoft/wichat_es5b/master/docker-compose.yml -O docker-compose.yml # docker compose --profile prod down # docker compose --profile prod up -d --pull always diff --git a/README.md b/README.md index 655bcf79..d066a322 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# wichat_0 +# wichat_es5b -[![Actions Status](https://github.com/arquisoft/wichat_0/workflows/CI%20for%20wichat_0/badge.svg)](https://github.com/arquisoft/wichat_0/actions) -[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wichat_0&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wichat_0) -[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wichat_0&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wichat_0) +[![Actions Status](https://github.com/arquisoft/wichat_es5b/workflows/CI%20for%20wichat_es5b/badge.svg)](https://github.com/arquisoft/wichat_es5b/actions) +[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wichat_es5b&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wichat_es5b) +[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Arquisoft_wichat_es5b&metric=coverage)](https://sonarcloud.io/summary/new_code?id=Arquisoft_wichat_es5b)

@@ -23,7 +23,7 @@ Both the user and auth service share a Mongo database that is accessed with mong First, clone the project: -```git clone git@github.com:arquisoft/wichat_0.git``` +```git clone git@github.com:arquisoft/wichat_es5b.git``` ### LLM API key configuration @@ -106,7 +106,7 @@ deploy: user: ${{ secrets.DEPLOY_USER }} key: ${{ secrets.DEPLOY_KEY }} command: | - wget https://raw.githubusercontent.com/arquisoft/wichat_0/master/docker-compose.yml -O docker-compose.yml + wget https://raw.githubusercontent.com/arquisoft/wichat_es5b/master/docker-compose.yml -O docker-compose.yml docker compose --profile prod down docker compose --profile prod up -d --pull always ``` diff --git a/docker-compose.yml b/docker-compose.yml index 62347892..fcde159e 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,6 +1,6 @@ services: mongodb: - container_name: mongodb-wichat_0 + container_name: mongodb-wichat_es5b image: mongo profiles: ["dev", "prod"] volumes: @@ -11,8 +11,8 @@ services: - mynetwork authservice: - container_name: authservice-wichat_0 - image: ghcr.io/arquisoft/wichat_0/authservice:latest + container_name: authservice-wichat_es5b + image: ghcr.io/arquisoft/wichat_es5b/authservice:latest profiles: ["dev", "prod"] build: ./users/authservice depends_on: @@ -25,8 +25,8 @@ services: MONGODB_URI: mongodb://mongodb:27017/userdb userservice: - container_name: userservice-wichat_0 - image: ghcr.io/arquisoft/wichat_0/userservice:latest + container_name: userservice-wichat_es5b + image: ghcr.io/arquisoft/wichat_es5b/userservice:latest profiles: ["dev", "prod"] build: ./users/userservice depends_on: @@ -39,8 +39,8 @@ services: MONGODB_URI: mongodb://mongodb:27017/userdb llmservice: - container_name: llmservice-wichat_0 - image: ghcr.io/arquisoft/wichat_0/llmservice:latest + container_name: llmservice-wichat_es5b + image: ghcr.io/arquisoft/wichat_es5b/llmservice:latest profiles: ["dev", "prod"] build: ./llmservice ports: @@ -49,8 +49,8 @@ services: - mynetwork gatewayservice: - container_name: gatewayservice-wichat_0 - image: ghcr.io/arquisoft/wichat_0/gatewayservice:latest + container_name: gatewayservice-wichat_es5b + image: ghcr.io/arquisoft/wichat_es5b/gatewayservice:latest profiles: ["dev", "prod"] build: ./gatewayservice depends_on: @@ -68,8 +68,8 @@ services: LLM_SERVICE_URL: http://llmservice:8003 webapp: - container_name: webapp-wichat_0 - image: ghcr.io/arquisoft/wichat_0/webapp:latest + container_name: webapp-wichat_es5b + image: ghcr.io/arquisoft/wichat_es5b/webapp:latest profiles: ["dev", "prod"] build: context: ./webapp @@ -82,7 +82,7 @@ services: prometheus: image: prom/prometheus - container_name: prometheus-wichat_0 + container_name: prometheus-wichat_es5b profiles: ["dev"] networks: - mynetwork @@ -96,7 +96,7 @@ services: grafana: image: grafana/grafana - container_name: grafana-wichat_0 + container_name: grafana-wichat_es5b profiles: ["dev"] networks: - mynetwork diff --git a/docs/README.md b/docs/README.md index daa34fa0..e6ede0e9 100644 --- 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/wichat_0/](https://arquisoft.github.io/wichat_0/). +The deployment url is: [https://arquisoft.github.io/wichat_es5b/](https://arquisoft.github.io/wichat_es5b/). ### 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/wichat_0/](https://arquisoft.github.io/wichat_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/wichat_es5b/](https://arquisoft.github.io/wichat_es5b/), 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. \ No newline at end of file diff --git a/docs/index.adoc b/docs/index.adoc index afa24113..ca9e36a9 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -6,7 +6,7 @@ // configure EN settings for asciidoc include::src/config.adoc[] -= image:arc42-logo.png[arc42] wichat_0 += image:arc42-logo.png[arc42] wichat_es5b :revnumber: 8.2 EN :revdate: January 2023 :revremark: (based upon AsciiDoc version) diff --git a/gatewayservice/package.json b/gatewayservice/package.json index 47bef53e..c6454af5 100644 --- a/gatewayservice/package.json +++ b/gatewayservice/package.json @@ -9,14 +9,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/arquisoft/wichat_0.git" + "url": "git+https://github.com/arquisoft/wichat_es5b.git" }, "author": "", "license": "ISC", "bugs": { - "url": "https://github.com/arquisoft/wichat_0/issues" + "url": "https://github.com/arquisoft/wichat_es5b/issues" }, - "homepage": "https://github.com/arquisoft/wichat_0#readme", + "homepage": "https://github.com/arquisoft/wichat_es5b#readme", "dependencies": { "axios": "^1.7.9", "cors": "^2.8.5", diff --git a/llmservice/package.json b/llmservice/package.json index 89ca3b7b..06c92e51 100644 --- a/llmservice/package.json +++ b/llmservice/package.json @@ -8,7 +8,7 @@ "author": "", "license": "ISC", "description": "", - "homepage": "https://github.com/arquisoft/wichat_0#readme", + "homepage": "https://github.com/arquisoft/wichat_es5b#readme", "dependencies": { "axios": "^1.7.9", "express": "^4.21.2" diff --git a/sonar-project.properties b/sonar-project.properties index e3f4d6c3..565326cc 100644 --- a/sonar-project.properties +++ b/sonar-project.properties @@ -1,9 +1,9 @@ sonar.organization=arquisoft sonar.host.url=https://sonarcloud.io -sonar.projectKey=Arquisoft_wichat_0 +sonar.projectKey=Arquisoft_wichat_es5b sonar.language=js -sonar.projectName=wichat_0 +sonar.projectName=wichat_es5b sonar.coverage.exclusions=**/*.test.js sonar.sources=webapp/src/components,users/authservice,users/userservice,llmservice,gatewayservice diff --git a/users/authservice/package.json b/users/authservice/package.json index 826832ed..9be970c6 100644 --- a/users/authservice/package.json +++ b/users/authservice/package.json @@ -9,14 +9,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/arquisoft/wichat_0.git" + "url": "git+https://github.com/arquisoft/wichat_es5b.git" }, "author": "", "license": "ISC", "bugs": { - "url": "https://github.com/arquisoft/wichat_0/issues" + "url": "https://github.com/arquisoft/wichat_es5b/issues" }, - "homepage": "https://github.com/arquisoft/wichat_0#readme", + "homepage": "https://github.com/arquisoft/wichat_es5b#readme", "dependencies": { "bcrypt": "^5.1.1", "body-parser": "^1.20.3", diff --git a/users/userservice/package.json b/users/userservice/package.json index cfdc8c40..cd04ab02 100644 --- a/users/userservice/package.json +++ b/users/userservice/package.json @@ -9,14 +9,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/arquisoft/wichat_0.git" + "url": "git+https://github.com/arquisoft/wichat_es5b.git" }, "author": "", "license": "ISC", "bugs": { - "url": "https://github.com/arquisoft/wichat_0/issues" + "url": "https://github.com/arquisoft/wichat_es5b/issues" }, - "homepage": "https://github.com/arquisoft/wichat_0#readme", + "homepage": "https://github.com/arquisoft/wichat_es5b#readme", "dependencies": { "bcrypt": "^5.1.1", "express": "^4.21.2", diff --git a/webapp/public/index.html b/webapp/public/index.html index e98a2199..82098958 100644 --- a/webapp/public/index.html +++ b/webapp/public/index.html @@ -24,7 +24,7 @@ work correctly both with client-side routing and a non-root public URL. Learn how to configure a non-root public URL by running `npm run build`. --> - wichat_0 + wichat_es5b