ci: common ci flow PL-87 (#1252)

* ci: common CI workflow

* ci: remove unnecessary console log

* ci: rename buildTest command

Author: Riippi

.github/workflows/ci.yml

@@ -1,17 +1,54 @@
 # This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
-name: Continuous Integration
+name: CI
 
 on:
   push:
     branches: [ main ]
   pull_request:
     branches: [ main ]
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
 
 jobs:
-  build:
+  common:
+    uses: City-of-Helsinki/.github/.github/workflows/ci-node.yml@main
+    secrets: inherit
+    with:
+      node-version: 22.x
+      extra-commands: |
+        echo "PORT=2048" >> $GITHUB_ENV
+        echo "SSR_FETCH_TIMEOUT=2500" >> $GITHUB_ENV
+        echo "ACCESSIBILITY_SENTENCE_API=https://www.hel.fi/palvelukarttaws/rest/v4" >> $GITHUB_ENV
+        echo "SERVICEMAP_API=https://api.hel.fi/servicemap/" >> $GITHUB_ENV
+        echo "SERVICEMAP_API_VERSION=v2" >> $GITHUB_ENV
+        echo "EVENTS_API=https://api.hel.fi/linkedevents/v1" >> $GITHUB_ENV
+        echo "RESERVATIONS_API=https://varaamo.hel.fi" >> $GITHUB_ENV
+        echo "PRODUCTION_PREFIX=SM" >> $GITHUB_ENV
+        echo "DIGITRANSIT_API=https://digitransit-proxy.api.hel.fi/routing/v1/routers/hsl/index/graphql" >> $GITHUB_ENV
+        echo "FEEDBACK_URL=https://api.hel.fi/servicemap/open311/" >> $GITHUB_ENV
+        echo "HEARING_MAP_API=https://kuulokuvat.fi/api/v1/servicemap-url" >> $GITHUB_ENV
+        echo "MODE=production" >> $GITHUB_ENV
+        echo "CITIES=helsinki,espoo,vantaa,kauniainen,kirkkonummi" >> $GITHUB_ENV
+        echo "ORGANIZATIONS=[{ \"id\": \"83e74666-0836-4c1d-948a-4b34a8b90301\", \"name\": { \"fi\": \"Helsingin kaupunki\", \"sv\": \"Helsingfors stad\", \"en\": \"City of Helsinki\" } },{ \"id\": \"520a4492-cb78-498b-9c82-86504de88dce\", \"name\": { \"fi\": \"Espoon kaupunki\", \"sv\": \"Esbo stad\", \"en\": \"City of Espoo\" } },{ \"id\": \"6d78f89c-9fd7-41d9-84e0-4b78c0fa25ce\", \"name\": { \"fi\": \"Vantaan kaupunki\", \"sv\": \"Vanda stad\", \"en\": \"City of Vantaa\" } },{ \"id\": \"6f0458d4-42a3-434a-b9be-20c19fcfa5c3\", \"name\": { \"fi\": \"Kauniaisten kaupunki\", \"sv\": \"Grankulla stad\", \"en\": \"Town of Kauniainen\" } },{ \"id\": \"015fd5cd-b280-4d24-a5b4-0ba6ecb4c8a4\", \"name\": { \"fi\": \"Kirkkonummi\", \"sv\": \"Kyrkslätt\", \"en\": \"Kirkkonummi\" } },{ \"id\": \"0c8e4f99-3d52-47b9-84df-395716bd8b11\", \"name\": { \"fi\": \"Länsi-Uudenmaan hyvinvointialue\", \"sv\": \"Västra Nylands välfärdsområde\", \"en\": \"Western Uusimaa Wellbeing Services County\" } },{ \"id\": \"5de91045-92ab-484b-9f96-7010ff7fb35e\", \"name\": { \"fi\": \"Vantaan ja Keravan hyvinvointialue\", \"sv\": \"Vanda och Kervo välfärdsområde\", \"en\": \"Wellbeing services county of Vantaa and Kerava\" } }]" >> $GITHUB_ENV
+        echo "SERVICE_MAP_URL=https://helsinki-maptiles.dev.hel.ninja/styles/hel-osm-bright-{language}/{z}/{x}/{y}{suffix}.png" >> $GITHUB_ENV
+        echo "ACCESSIBLE_MAP_URL=https://helsinki-maptiles.dev.hel.ninja/styles/turku-osm-high-contrast-pattern-{language}/{z}/{x}/{y}{suffix}.png" >> $GITHUB_ENV
+        echo "ORTOGRAPHIC_MAP_URL=https://kartta.hsy.fi/geoserver/gwc/service/wmts?layer=taustakartat_ja_aluejaot:Ortoilmakuva_2019&tilematrixset=ETRS-GK25&Service=WMTS&Request=GetTile&Version=1.0.0&TileMatrix=ETRS-GK25:{z}&TileCol={x}&TileRow={y}&Format=image/png" >> $GITHUB_ENV
+        echo "ORTOGRAPHIC_WMS_URL=https://kartta.hsy.fi/geoserver/wms" >> $GITHUB_ENV
+        echo "ORTOGRAPHIC_WMS_LAYER=taustakartat_ja_aluejaot:Ortoilmakuva_2019" >> $GITHUB_ENV
+        echo "GUIDE_MAP_URL=https://kartta.hel.fi/ws/geoserver/avoindata/gwc/service/wmts?layer=avoindata:Karttasarja_PKS&tilematrixset=ETRS-GK25&Service=WMTS&Request=GetTile&Version=1.0.0&TileMatrix=ETRS-GK25:{z}&TileCol={x}&TileRow={y}&Format=image/png" >> $GITHUB_ENV
+        echo "PLAIN_MAP_URL=https://mml-tiles.hel.ninja/avoin/wmts/1.0.0/selkokartta/default/ETRS-TM35FIN/{z}/{y}/{x}.png" >> $GITHUB_ENV
+        echo "READ_FEEDBACK_URLS_HELSINKI=https://palautteet.hel.fi/fi/hae-palautteita#/app/search?r=12&text=,https://palautteet.hel.fi/sv/hae-palautteita#/app/search?r=12&text=,https://palautteet.hel.fi/en/hae-palautteita#/app/search?r=12&text=" >> $GITHUB_ENV
+        echo "ADDITIONAL_FEEDBACK_URLS_ESPOO=https://easiointi.espoo.fi/eFeedback/fi,https://easiointi.espoo.fi/eFeedback/sv,https://easiointi.espoo.fi/eFeedback/en" >> $GITHUB_ENV
+        echo "ADDITIONAL_FEEDBACK_URLS_KAUNIAINEN=https://www.kauniainen.fi/kaupunki-ja-paatoksenteko/osallistu-ja-vaikuta/,https://www.kauniainen.fi/sv/staden-och-beslutsfattande/delta-och-paverka/,https://www.kauniainen.fi/kaupunki-ja-paatoksenteko/osallistu-ja-vaikuta/" >> $GITHUB_ENV
+        echo "ADDITIONAL_FEEDBACK_URLS_KIRKKONUMMI=https://kirkkonummi.fi/anna-palautetta-ja-vaikuta/,https://kyrkslatt.fi/ge-respons-och-paverka/,https://kirkkonummi.fi/anna-palautetta-ja-vaikuta/" >> $GITHUB_ENV
+        echo "ADDITIONAL_FEEDBACK_URLS_VANTAA=https://www.vantaa.fi/fi/palaute,https://www.vantaa.fi/sv/feedback,https://www.vantaa.fi/en/feedback" >> $GITHUB_ENV
+        echo "SLOW_FETCH_MESSAGE_TIMEOUT=3000" >> $GITHUB_ENV
+        echo "HELSINKI_MAPTILES_ENABLED=true" >> $GITHUB_ENV
 
+  e2e:
+    needs: common
     runs-on: ubuntu-latest
 
     env:
@@ -44,21 +81,17 @@ jobs:
       SLOW_FETCH_MESSAGE_TIMEOUT: 3000
       HELSINKI_MAPTILES_ENABLED: true
 
-    strategy:
-      matrix:
-        node-version: [22.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
-
     steps:
-    - uses: actions/checkout@v4
-      with:
-        fetch-depth: 0
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: yarn install --frozen-lockfile
-    - run: yarn testBuild
-    - run: yarn test
-    - run: yarn test:e2e:install
-    - run: yarn test:e2e
+      - uses: actions/checkout@v4
+      - name: Use Node.js 22.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build application
+        run: yarn build
+      - name: Install Playwright browsers
+        run: yarn test:e2e:install
+      - name: Run E2E tests
+        run: yarn test:e2e

README.md

@@ -21,7 +21,7 @@ Start dev server and runs the app in the development mode.<br>
 
 Builds the app for production to the `dist` folder.<br>
 
-### `yarn testBuild`
+### `yarn build:test`
 
 Builds the app in development mode to the `dist` folder.<br>
 

config/default.js

@@ -15,7 +15,7 @@ function getVersion() {
   if (typeof window !== 'undefined' && typeof window.nodeEnvSettings !== 'undefined') {
     version = window.nodeEnvSettings.appVersion;
   }
-  console.log('Palvelukartta version:', `${version.tag} / ${version.commit}`);
+  // On local development, version is not set, but works ok with undefined.
   return version;
 }
 

package.json

@@ -63,10 +63,12 @@
   "scripts": {
     "start": "node dist",
     "build": "NODE_ENV=production BABEL_ENV=production webpack --mode production ",
-    "testBuild": "NODE_ENV=development BABEL_ENV=development webpack --mode development",
+    "build:test": "NODE_ENV=development BABEL_ENV=development webpack --mode development",
     "test": "jest test",
+    "test:coverage": "jest test --coverage",
     "test:e2e:install": "playwright install",
     "test:e2e": "playwright test",
+    "lint": ":",
     "eject": "react-scripts eject",
     "dev": "NODE_ENV=development BABEL_ENV=development webpack --watch --progress & nodemon dist",
     "production": "NODE_ENV=production BABEL_ENV=production webpack --progress --mode production && node dist"
@@ -101,7 +103,6 @@
     "eslint-plugin-jsx-a11y": "^6.4.1",
     "eslint-plugin-react": "^7.32.2",
     "eslint-plugin-react-hooks": "^4.5.0",
-    "git-revision-webpack-plugin": "5.0.0",
     "identity-obj-proxy": "^3.0.0",
     "jest": "^29.5.0",
     "jest-canvas-mock": "^2.5.1",

sonar-project.properties

@@ -9,4 +9,4 @@ sonar.projectVersion=1.0
 sonar.sourceEncoding=UTF-8
 
 # Exclude translation files from duplication analysis
-sonar.exclusions=**/i18n/*,**/__tests__/**,e2e/**/*,playwright.config.js
+sonar.exclusions=**/i18n/*,**/__tests__/**,e2e/**/*,playwright.config.js,webpack.config.js

webpack.config.js

@@ -67,13 +67,31 @@ const css = {
   ],
 };
 
+const getGitTag = () => {
+  try {
+    return cp.execSync('git describe --abbrev=0 --tags', { cwd: '.' })
+      .toString()
+      .replace(/\r?\n|\r/g, '');
+  } catch (error) {
+    // Fallback when no tags exist
+    return 'no-tag';
+  }
+};
+
+const getGitCommit = () => {
+  try {
+    return cp.execSync('git rev-parse --short HEAD', { cwd: '.' })
+      .toString()
+      .trim();
+  } catch (error) {
+    // Fallback when git is not available
+    return 'unknown';
+  }
+};
+
 const gitVersionInfoPlugin = new webpack.DefinePlugin({
-  GIT_TAG: JSON.stringify(cp.execSync('git describe --abbrev=0 --tags', { cwd: '.' })
-    .toString()
-    .replace(/\r?\n|\r/g, '')),
-  GIT_COMMIT: JSON.stringify(cp.execSync('git rev-parse --short HEAD', { cwd: '.' })
-    .toString()
-    .trim()),
+  GIT_TAG: JSON.stringify(getGitTag()),
+  GIT_COMMIT: JSON.stringify(getGitCommit()),
 });
 
 const plugins = [gitVersionInfoPlugin];

yarn.lock

@@ -7143,11 +7143,6 @@ get-symbol-description@^1.1.0:
     es-errors "^1.3.0"
     get-intrinsic "^1.2.6"
 
-git-revision-webpack-plugin@5.0.0:
-  version "5.0.0"
-  resolved "https://registry.yarnpkg.com/git-revision-webpack-plugin/-/git-revision-webpack-plugin-5.0.0.tgz#0683a6a110ece618499880431cd89e1eb597b536"
-  integrity sha512-RptQN/4UKcEPkCBmRy8kLPo5i8MnF8+XfAgFYN9gbwmKLTLx4YHsQw726H+C5+sIGDixDkmGL3IxPA2gKo+u4w==
-
 glob-parent@^5.1.2, glob-parent@~5.1.2:
   version "5.1.2"
   resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4"