maksit-certs-ui/utils/engines/release/scriptSettings.json

{
  "$schema": "https://json-schema.org/draft-07/schema",
  "title": "Release Package Script Settings",
  "description": "maksit-certs-ui: container images (Web API + Web UI) and Helm chart to OCI. No NuGet packages or zip archives. ReleasePublishGuard (before Docker/Helm) controls allowed branches and tag rules; publish plugins omit branches. Engine aligned with maksit-repoutils.",
  "plugins": [
    {
      "name": "DotNetReleaseVersion",
      "stageLabel": "build",
      "enabled": true,
      "projectFiles": [
        "..\\..\\..\\src\\MaksIT.CertsUI\\MaksIT.CertsUI.csproj"
      ]
    },
    {
      "name": "DotNetTest",
      "stageLabel": "test",
      "enabled": true,
      "projects": [
        "..\\..\\..\\src\\MaksIT.CertsUI.Engine.Tests",
        "..\\..\\..\\src\\MaksIT.CertsUI.Tests"
      ],
      "resultsDir": "..\\..\\..\\testResults"
    },
    {
      "name": "QualityGate",
      "stageLabel": "qualityGate",
      "enabled": true,
      "coverageThreshold": 0,
      "scanVulnerabilities": false
    },
    {
      "name": "ReleasePublishGuard",
      "stageLabel": "release",
      "enabled": true,
      "branches": [
        "main"
      ],
      "requireExactTagOnHead": true,
      "tagVersionMustMatchDotNetRelease": true,
      "whenRequirementsNotMet": "skip",
      "requireCleanWorkingTree": false,
      "ensureTagOnRemote": true,
      "remoteName": "origin"
    },
    {
      "name": "DotNetDockerPush",
      "stageLabel": "release",
      "enabled": true,
      "registryUrl": "cr.maks-it.com",
      "credentialsEnvVar": "CR_MAKS_IT",
      "projectName": "certs-ui",
      "contextPath": "..\\..\\..\\src",
      "pushLatest": true,
      "images": [
        {
          "service": "server",
          "dockerfile": "MaksIT.CertsUI/Dockerfile"
        },
        {
          "service": "client",
          "dockerfile": "MaksIT.WebUI/Dockerfile.prod",
          "versionEnvFiles": [
            "MaksIT.WebUI/.env",
            "MaksIT.WebUI/.env.prod"
          ]
        },
        {
          "service": "reverseproxy",
          "dockerfile": "ReverseProxy/Dockerfile"
        }
      ]
    },
    {
      "name": "DotNetHelmPush",
      "stageLabel": "release",
      "enabled": true,
      "chartPath": "..\\..\\..\\src\\helm",
      "ociRepository": "oci://cr.maks-it.com/charts",
      "credentialsEnvVar": "CR_MAKS_IT",
      "pushLatest": false
    }
  ],
  "_comments": {
    "plugins": {
      "name": "Plugin module name (for example, DotNetDockerPush -> plugins/DotNet/DotNetDockerPush.psm1). Lookup: engines/release/custom, then plugins/Platform, DotNet, Npm.",
      "stageLabel": "Execution phase: test, qualityGate, build, or release (lowercase). Plugin failures stop the run and report RELEASE FAILED.",
      "enabled": "If true, the plugin is imported and Invoke-Plugin is called in the configured order.",
      "DotNetReleaseVersion": "Reads <Version> from the first projectFiles entry; ReleasePublishGuard checks tag on HEAD matches when tagVersionMustMatchDotNetRelease is true.",
      "projects": "DotNetTest: array of test project paths relative to engines/release. Requires utils/modules/TestRunner.psm1 (multi-project Cobertura aggregation).",
      "resultsDir": "DotNetTest: optional; when multiple projects are listed, TestRunner uses engines/release/TestResults if omitted.",
      "projectFiles": "QualityGate: add .csproj paths when scanVulnerabilities is true (dotnet list package --vulnerable).",
      "scanVulnerabilities": "QualityGate: false = no dotnet list; true requires projectFiles. failOnVulnerabilities optional when scan is true (default true).",
      "coverageThreshold": "QualityGate: >0 requires line % on shared context (qualityLineCoverage, coverageLineRate, or testResult.LineRate). 0 disables.",
      "registryUrl": "DotNetDockerPush: registry host without scheme.",
      "credentialsEnvVar": "DotNetDockerPush / DotNetHelmPush: env var with base64(username:password).",
      "projectName": "DotNetDockerPush: image path segment: registryUrl/projectName/service:tag.",
      "contextPath": "DotNetDockerPush: directory containing MaksIT.CertsUI and MaksIT.WebUI (repo src/).",
      "images": "DotNetDockerPush: [{ service, dockerfile, contextPath?, versionEnvFiles? }]. dockerfile and versionEnvFiles are relative to the image contextPath when set, otherwise plugin contextPath.",
      "versionEnvFiles": "DotNetDockerPush image option: array of files (relative to the image build context) where VITE_APP_VERSION is temporarily set to shared.version before docker build, then restored after build/push.",
      "chartPath": "DotNetHelmPush: directory containing Chart.yaml. Keep version/appVersion as placeholders in git (e.g. 0.0.0); DotNetHelmPush overwrites with bare semver from DotNetReleaseVersion (shared.version, e.g. 3.3.4, no v) before package/push; falls back to stripping v from shared.tag if version is missing.",
      "ociRepository": "DotNetHelmPush: OCI registry URL for helm push (e.g. oci://cr.maks-it.com/charts).",
      "pushLatest": "DotNetDockerPush: also push :latest (images also get bare :3.3.4 and :v3.3.4 from DotNetReleaseVersion). DotNetHelmPush: oras copy chart to :latest (requires oras on PATH).",
      "branches": "ReleasePublishGuard: allowed branches for publish (omit or [\"*\"] = any). Do not put branches on DotNetDockerPush/DotNetHelmPush/GitHub/DotNetNuGet.",
      "requireExactTagOnHead": "ReleasePublishGuard: require git describe --tags --exact-match HEAD (vX.Y.Z).",
      "tagVersionMustMatchDotNetRelease": "ReleasePublishGuard: tag semver must equal DotNetReleaseVersion when true.",
      "whenRequirementsNotMet": "ReleasePublishGuard: skip (suppress publish plugins) or fail (exit 1).",
      "requireCleanWorkingTree": "ReleasePublishGuard: block publish if git status is not clean.",
      "ensureTagOnRemote": "ReleasePublishGuard: push tag to remote if missing.",
      "remoteName": "ReleasePublishGuard: git remote for tag push (default origin).",
      "maksit-repoutils": "Full engine and plugin docs: https://github.com/MAKS-IT-COM/maksit-repoutils"
    }
  }
}