.gitlab-ci.yml

 stages:
-  - build
-  - test
-  - deploy
+  - build 📦
+  # - test
+  - fetch-version 🔎
+  - deploy 🚅
+  - release 🚀
+
+.common_release_config:
+  image: node:18
+  variables:
+    HUSKY: 0
+  before_script:
+    - npm install
 
 variables:
   REGISTRY_STATION_SOFTWARE_IMAGE: $CI_REGISTRY_IMAGE/station-software
@@ -12,21 +21,22 @@ build_station_software:
   image: docker:23-dind
   services:
     - docker:23-dind
-  stage: build
+  stage: build 📦
   before_script:
     - apk update && apk add git
     - echo "$CI_BUILD_TOKEN" | docker login -u "$CI_REGISTRY_USER" --password-stdin $CI_REGISTRY
   script:
-    - echo "Build stationsoftware image!"
-    - docker build --pull -t $REGISTRY_STATION_SOFTWARE_IMAGE:$CI_COMMIT_SHA .
+    - echo "Building Station Software 🚧"
+    - docker build --pull -t $REGISTRY_STATION_SOFTWARE_IMAGE:$CI_COMMIT_SHA -t $REGISTRY_STATION_SOFTWARE_IMAGE:$CI_COMMIT_REF_NAME .
     - docker push $REGISTRY_STATION_SOFTWARE_IMAGE:$CI_COMMIT_SHA
-    - echo "build complete!"
+    - docker push $REGISTRY_STATION_SOFTWARE_IMAGE:$CI_COMMIT_REF_NAME
+    - echo "Station Software Build Complete! ✅"
 
 build_dind:
   image: docker:23-dind
   services:
     - docker:23-dind
-  stage: build
+  stage: build 📦
   before_script:
     - apk update && apk add git
     - echo "$CI_BUILD_TOKEN" | docker login -u "$CI_REGISTRY_USER" --password-stdin $CI_REGISTRY
@@ -40,7 +50,7 @@ build_vault:
   image: docker:23-dind
   services:
     - docker:23-dind
-  stage: build
+  stage: build 📦
   before_script:
     - apk update && apk add git
     - echo "$CI_BUILD_TOKEN" | docker login -u "$CI_REGISTRY_USER" --password-stdin $CI_REGISTRY
@@ -50,27 +60,43 @@ build_vault:
     - docker push $REGISTRY_VAULT_IMAGE:$CI_COMMIT_SHA
     - echo "build complete!"
 
-test_station_software:
-  image: node:16.2.0
-  stage: test
-  needs:
-    - build_station_software
+### COMMENTING FOR NOW
+### TEST COVERAGE CAN BE PRIORITIZED LATER
+# test_station_software:
+#   image: node:16.2.0
+#   stage: test
+#   needs:
+#     - build_station_software
+#   script:
+#     - echo "Test station software!"
+#     - ls
+#     - npm install
+#     - npx jest --ci --reporters=default --reporters=jest-junit
+#   artifacts:
+#     when: always
+#     reports:
+#       junit:
+#         - junit.xml
+
+fetch_semantic_version:
+  extends: .common_release_config
+  stage: fetch-version 🔎
   script:
-    - echo "Test station software!"
-    - ls
-    - npm install
-    - npx jest --ci --reporters=default --reporters=jest-junit
+    - echo "Fetching Station Software release version 🚧"
+    - npx semantic-release --dry-run
+    - echo "Release Version added to Artifacts ✅"
   artifacts:
-    when: always
     reports:
-      junit:
-        - junit.xml
+      dotenv: variables.env
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+    - if: $CI_COMMIT_BRANCH == "prerelease"
 
 deploy_image_branch:
   image: docker:23-dind
   services:
     - docker:23-dind
-  stage: deploy
+  stage: deploy 🚅
   variables:
     CI_HARBOR_REGISTRY: repository.padme-analytics.de/stationsoftware
     HARBOR_STATION_SOFTWARE_IMAGE: $CI_HARBOR_REGISTRY/station-software
@@ -80,39 +106,52 @@ deploy_image_branch:
     - apk update && apk add git
     - echo $HARBOR_REGISTRY_PASSWORD | docker login -u $HARBOR_REGISTRY_USER --password-stdin $HARBOR_REGISTRY
   script:
+    - echo "Deploying Station Software image to Harbor with version v$RELEASE_VERSION 🚅"
     - docker tag $REGISTRY_STATION_SOFTWARE_IMAGE:$CI_COMMIT_SHA $HARBOR_STATION_SOFTWARE_IMAGE:$CI_COMMIT_BRANCH
+    - docker tag $REGISTRY_STATION_SOFTWARE_IMAGE:$CI_COMMIT_SHA $HARBOR_STATION_SOFTWARE_IMAGE:$RELEASE_VERSION
     - docker push $HARBOR_STATION_SOFTWARE_IMAGE:$CI_COMMIT_BRANCH
+    - docker push $HARBOR_STATION_SOFTWARE_IMAGE:$RELEASE_VERSION
     - docker tag $REGISTRY_DIND_IMAGE:$CI_COMMIT_SHA $HARBOR_DIND_IMAGE:$CI_COMMIT_BRANCH
     - docker push $HARBOR_DIND_IMAGE:$CI_COMMIT_BRANCH
     - docker tag $REGISTRY_VAULT_IMAGE:$CI_COMMIT_SHA $HARBOR_VAULT_IMAGE:$CI_COMMIT_BRANCH
     - docker push $HARBOR_VAULT_IMAGE:$CI_COMMIT_BRANCH
-  only:
-    - main
-    - prerelease
-
-pages:
-  image: ubuntu:latest
-  stage: deploy
   rules:
-    - if: "$CI_COMMIT_BRANCH==$CI_DEFAULT_BRANCH"
-    - if: '$CI_COMMIT_BRANCH== "prerelease"'
+    - if: $CI_COMMIT_BRANCH == "main"
+    - if: $CI_COMMIT_BRANCH == "prerelease"
+
+release:
+  extends: .common_release_config
+  stage: release 🚀
   script:
-    - cp Installscript/padmetools.sh public/
-  artifacts:
-    paths:
-      - public
+    - npx semantic-release
+  rules:
+    - if: $CI_COMMIT_BRANCH == "main"
+    - if: $CI_COMMIT_BRANCH == "prerelease"
 
-include:
-  - template: Code-Quality.gitlab-ci.yml
 
-code_quality:
-  artifacts:
-    expose_as: "Code Quality Report"
-    paths: [gl-code-quality-report.json]
-    expire_in: 365 days
-  rules:
-    - if: "$CODE_QUALITY_DISABLED"
-      when: never
-    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
-    - if: '$CI_COMMIT_BRANCH == "main"'
-    - if: '$CI_COMMIT_BRANCH == "prerelease"'
+# pages:
+#   image: ubuntu:latest
+#   stage: deploy
+#   rules:
+#     - if: "$CI_COMMIT_BRANCH==$CI_DEFAULT_BRANCH"
+#     - if: '$CI_COMMIT_BRANCH== "prerelease"'
+#   script:
+#     - cp Installscript/padmetools.sh public/
+#   artifacts:
+#     paths:
+#       - public
+
+# include:
+#   - template: Code-Quality.gitlab-ci.yml
+
+# code_quality:
+#   artifacts:
+#     expose_as: "Code Quality Report"
+#     paths: [gl-code-quality-report.json]
+#     expire_in: 365 days
+#   rules:
+#     - if: "$CODE_QUALITY_DISABLED"
+#       when: never
+#     - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
+#     - if: '$CI_COMMIT_BRANCH == "main"'
+#     - if: '$CI_COMMIT_BRANCH == "prerelease"'

.husky/commit-msg

+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no -- commitlint --edit "$1"

Dockerfile

@@ -3,11 +3,16 @@ FROM node:latest as node_cache
 # Create app directory
 WORKDIR /usr/src/app
 
+ENV NODE_ENV=production
+
 # Install app dependencies
 # A wildcard is used to ensure both package.json AND package-lock.json are copied
 # where available (npm@5+)
 COPY package*.json ./
-RUN npm install
+
+# Disable husky in CI/Docker/Prod
+# Install only production dependencies in the Docker image to reduce size
+RUN npm pkg delete scripts.prepare && npm ci --omit=dev
 
 #Install dependencies for wizard UI
 COPY wizard-frontend/package*.json ./wizard-frontend/

Dockerfile.dev

+FROM node:latest as node_cache
+
+# Create app directory
+WORKDIR /usr/src/app
+
+# Install app dependencies
+# A wildcard is used to ensure both package.json AND package-lock.json are copied
+# where available (npm@5+)
+COPY package*.json ./
+RUN npm install
+
+#Install dependencies for wizard UI
+COPY wizard-frontend/package*.json ./wizard-frontend/
+RUN npm --prefix wizard-frontend install
+
+#Install dependencies for main UI
+COPY station-frontend/package*.json ./station-frontend/
+RUN npm --prefix station-frontend install
+
+FROM gcr.io/projectsigstore/cosign:v2.2.1 as cosign-bin
+
+FROM node:latest
+
+WORKDIR /usr/src/app
+
+COPY --from=node_cache /usr/src/app/ .
+
+# Bundle app source
+COPY . .
+
+RUN mkdir /lockfiledir
+
+# Copy cosign binary
+COPY --from=cosign-bin /ko-app/cosign /usr/local/bin/cosign
+
+EXPOSE 3030
+CMD [ "npm", "run", "dev" ]

README.md

@@ -51,4 +51,8 @@ To hold the tests for one javascript file a.js, create a corrosponding test file
 
 ### Static code analysis
 For ensuring code quality and to prevent bugs, we use eslint for static code analysis. You can run the linter with `npx run eslint .`.
-Ensure that the linter does not produce any critical error and as few warnings as possible. You can use the linter to fix some errors by adding a `--fix` flag.
+Ensure that the linter does not produce any critical error and as few warnings as possible. You can use the linter to fix some errors by adding a `--fix` flag.
\ No newline at end of file
+
+### Major Release Commit
+
+### Minor Release Commit
\ No newline at end of file

StationDeploymentFiles/docker-compose-dev.yml

@@ -55,7 +55,9 @@ services:
     restart: unless-stopped
 
   pht-web:
-    build: ../
+    build:
+      context: ../
+      dockerfile: Dockerfile.dev
     container_name: '${PROJECTNAME}pht-web'
     command: ${COMMAND-/bin/sh -c "while sleep 1000; do :; done"}
     ports:

app.js

@@ -19,7 +19,7 @@ function randomString(size = 21) {
 
 var app = express();
 
-if (process.env.NODE_ENV) {
+if (process.env.NODE_ENV === "development") {
   app.use(
     cors({
       origin: ["http://localhost:3001", "http://127.0.0.1:3001"],

commitlint.config.js

+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+};

installationWizard/app.js

@@ -12,7 +12,7 @@ const app = express();
  * Port can be replaced with whatever port react
  * app is running on.
  */
-if (process.env.NODE_ENV) {
+if (process.env.NODE_ENV === "development") {
   app.use(
     cors({
       origin: ["http://localhost:3001", "http://127.0.0.1:3001"],

package.json

 {
-  "name": "pht-web",
-  "version": "0.0.0",
+  "name": "@padme-development/padme-station-software",
+  "version": "2.0.0",
+  "description": "A Dockerized Javascript Web Application providing interfaces for Monitoring of the algorithms and components, which manage the business logic e.g. pulling a train, execute a train, inspect the results, and many more.",
+  "license": "MIT",
+  "homepage": "https://git.rwth-aachen.de/padme-development/padme-station-software",
   "private": true,
   "scripts": {
+    "cm": "cz",
     "build:wizard": "npm run build --prefix wizard-frontend",
     "build:station": "npm run build --prefix station-frontend",
     "start": "npm run build:wizard && npm run build:station && node ./bin/www",
     "dev": "NODE_ENV=development nodemon ./bin/www",
-    "test": "jest"
+    "test": "jest",
+    "semantic-release": "semantic-release"
   },
   "dependencies": {
     "async-mutex": "^0.4.0",
@@ -35,12 +40,60 @@
     "wait-queue": "^1.1.4"
   },
   "devDependencies": {
+    "@commitlint/cli": "^18.4.3",
+    "@commitlint/config-conventional": "^18.4.3",
+    "@semantic-release/exec": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/gitlab": "^12.1.1",
+    "commitizen": "^4.3.0",
     "cors": "^2.8.5",
+    "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.48.0",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-plugin-import": "^2.28.1",
     "jest": "^29.6.4",
     "jest-junit": "^16.0.0",
-    "nodemon": "^3.0.1"
+    "nodemon": "^3.0.1",
+    "semantic-release": "^22.0.8"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "release": {
+    "branches": [
+      "main",
+      "prerelease"
+    ],
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/gitlab",
+      [
+        "@semantic-release/npm",
+        {
+          "npmPublish": false
+        }
+      ],
+      [
+        "@semantic-release/exec",
+        {
+          "verifyReleaseCmd": "echo \"RELEASE_VERSION=${nextRelease.version}\" > variables.env"
+        }
+      ],
+      [
+        "@semantic-release/git",
+        {
+          "assets": [
+            "package.json"
+          ],
+          "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+        }
+      ]
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "cz-conventional-changelog"
+    }
   }
 }