Kihagyás

Projekt specifikus átnevezések

A projekt kódbázisában (pom.xml, package.json stb.) különböző formában megjelenhet az adott ügyfél/projekt/alkalmazás neve.

Értelemszerűen ez minden projekt esetén egyedi így amennyiben a Semi Productból indultunk a szükséges átnevezéseket nekünk kell elvégezni.

Lokális környezet beállítása

Az átnevezéseket könnyebb megcsinálni, ha az új projektet be is állítjuk IntelliJ-ben. A backend projekt beállításához itt, míg a frontend projekt beállításához itt található leírás.

1. api projekt átnevezések

1.1 Definiciós fájl átnevezések

A common/meta/meta-data.yml fájlban az info szekcióban írjuk át a title paraméterek értékét a projekt nevének megfelelő értékekre. Ezen kívül a contact.email paraméter értékét is írjuk át, hogy a projekt email csoportjának címe szerepeljen benne.

1.2 CI-al kapcsolatos átnevezések

A főkönyvtárban található .gitlab-ci.yml fájlban, frissítsük a variables szekcióban a BACKEND_PROJECT_ID értékét, a backend GitLab project id-jára.

A backend projekt id-ját megtaláljuk, ha megnyitjuk GitLab-on a backend projektet, majd a képernyő tetején jobb oldalt az „Actions“ (3 pötty) ikonra kattintunk:

BackendProjectId

2. backend és bot projekt átnevezések

Ezt a lépést a backend és bot projekteken is végre kell hajtani.

Írjuk át a maven modulok groupId-ját a pom.xml-ekben:

Pl.: 

    <groupId>io.gbsolutions.${project-name}</groupId>
    <artifactId>backend</artifactId>
    <version>0.0.0-SNAPSHOT</version>

A ${project-name} helyére az adott projekt vagy ügyfél nevét kell beírni.

groupId elnevezési konvenciók

Az elnevezéseknél a Maven konvencióit vesszük alapul amiről itt olvashattok bővebben.

A backend projekt esetén ne felejtsük el a backend, az emulator-service és a backend-service könyvtár alatti pom.xml-t is frissíteni.

3. frontend projekt átnevezések

3.1 A package.json átírása

  1. Írjuk át a package.json fájlban található name property értékét a projekt nevére.

  2. Frissítsük a a package.json fájlban a config.backend_project_id property értékét a backend GitLab project id-jára.

    A backend projekt id-ját megtaláljuk, ha megnyitjuk GitLab-on a backend projektet, majd a képernyő tetején jobb oldalt az „Actions“ (3 pötty) ikonra kattintunk:

    BackendProjectId

4. documentation projekt átnevezések

4.1 Az mkdocs.yml fájl frissítése

Az mkdocs.yml fájlban:

  • A projekt nevének megfelelően frissítsük a site_name paramétert. 

    site_name: ${projekt-név}

  • A GitLab Pages URL-re frissítsük be a site_url paramétert. 

    site_url: https://gbsolutions.gitlab.io/${projekt-group-név}/documentation/

Fontos

Ahhoz, hogy meg tudjuk nézni a GitLab Pages URL-jét le kell futnia a pages-job-nak.
Ez a job automatikusan lefut minden egyes develop branch commit esetén, de manuálisan is le tudjuk futtatni.

  • A projekt GitLab group nevére frissítsük az extra.project_group_name paramétert: 

    extra:
  project_group_name: '${projekt-group-név}'

  • Frissítsük a extra.homepage paramétert, hogy a projekt neve szerepeljen benne: 

    extra:
  homepage: '${projekt-group-név}/summary/'

  • (Opcionális) Igény szerint a theme.favicon theme.logo paraméterekkel a dokumentáció logóját és faviconját is lecserélhetjük a projektet azonosító logóra/ikonra. 

    site_dir: public
theme:
    favicon: 'assets/img/logos/favicon.png'
    logo: 'assets/img/logos/${projekt-név}.png'

  • A ${projekt-név} placeholder helyére értelemszerűen a projekt nevét kell behelyettesíteni.

  • A ${projekt-group-név} placeholder helyére értelemszerűen a projekt GitLab group nevét kell behelyettesíteni.

4.2 A .gitlab-ci-deploy.yml fájl frissítése

A .gitlab-ci-deploy.yml fájlban az alábbi sort:

Keresés az alábbi sorokra

Amennyiben az IntelliJ nem találja az alábbi sort, próbáljuk meg a - karakter nélkül beírni a keresőbe.

- python3 -m mkdocs build --strict --verbose --site-dir public/semi-product/documentation

Frissítsük a projekt nevének megfelelően: 

- python3 -m mkdocs build --strict --verbose --site-dir public/${projekt-group-név}/documentation

  • A ${projekt-group-név} placeholder helyére értelemszerűen a projekt GitLab group nevét kell behelyettesíteni.

4.3 README.md frissítése

A README.md fájlban frissítsük a dokumentáció GitLab Pages URL-jét: 

https://gbsolutions.gitlab.io/semi-product/documentation/semi-product/summary/
Az alábbira: 
https://gbsolutions.gitlab.io/${projekt-group-név}/documentation/semi-product/summary/

  • A ${projekt-group-név} placeholder helyére értelemszerűen a projekt GitLab group nevét kell behelyettesíteni.

GitLab Pages URL

Amennyiben bizonytalanok vagyunk azzal kapcsolatban, hogy mi a projektünkön a GitLab Pages url, akkor GitLab-on is ellenőrizhetjük:

  1. Győződjünk meg róla, hogy a pages job már legalább egyszer lefutott a projekt documentation repositoryjára.

    Manuális pages-job pipeline lefuttatása GitLab-en keresztül:

    1. Nyissuk meg a GitLab repository-ban a documentation repo-t.
    2. Bal oldalon navigáljunk a Build -> Pipelines szekcióhoz.
    3. A felső sávban kattintsunk a Run Pipelines gombra.
      RunPipelines
    4. A develop branch-et kiválasztva indítsuk el a pipeline-t a Run Pipeline gombbal.
    5. Ha sikeresen lefutott a build a következőt fogjuk látni:
      SuccessfulPipeline

  2. Ezt követően a documentation repositoryban a baloldali menüsorban kattintsunk a Deploy-ra és válasszuk ki a Pages menüpontot.

  3. Amennyiben a Use unique domains checkbox be van pipálva, azt vegyük ki és kattintsunk a Save changes gombra.

    GitLabPagesUniqueDomains

  4. A megnyíló képernyőn az Access pages dobozban találjuk az URL-t:

    GitLabPagesUrl

4.4 Az oboarding.md fájlok firssítése

A docs/development/frontend/onboarding.md és docs/development/backend/onboarding.md fájlokban frissítsük a projektek klónozásához használt Git repository URL-eket.

Frontend: 

git clone git@gitlab.com:gbsolutions/semi-product/frontend.git

Helyette: 

git clone git@gitlab.com:gbsolutions/${projekt-group-név}/frontend.git

Backend: 

git clone git@gitlab.com:gbsolutions/semi-product/backend.git

Helyette: 

git clone git@gitlab.com:gbsolutions/${projekt-group-név}/backend.git

Mindkét fájlban szerepel az API repository klónozása is, azt is frissítsük természetesen:

git clone git@gitlab.com:gbsolutions/semi-product/api.git

Modósítsuk a projektnek megfelelően: 

git clone git@gitlab.com:gbsolutions/${projekt-group-név}/api.git

  • A ${projekt-group-név} placeholder helyére értelemszerűen a projekt GitLab group nevét kell behelyettesíteni.