ci: add a new workflow for pre-release tags (#396)

* ci: add a new workflow for pre-release tags with instructions in development.md

Signed-off-by: Nicklas Silversved <nicklas.silversved@digg.se>

Author: brorlarsnicklas

.github/workflows/pre-release-workflow.yaml

@@ -0,0 +1,28 @@
+# SPDX-FileCopyrightText: 2025 diggsweden/rest-api-profil-lint-processor
+#
+# SPDX-License-Identifier: EUPL-1.2
+
+---
+name: RAP-LP Pre-release
+
+on:
+  push:
+    tags:
+      - 'v*.*.*-alpha.*'
+      - 'v*.*.*-beta.*'
+      - 'v*.*.*-rc.*'
+
+jobs:
+  publish-package:
+    uses: ./.github/workflows/publish-package.yaml
+    permissions:
+      contents: read
+      packages: write
+
+  publish-image:
+    needs: publish-package
+    uses: ./.github/workflows/publish-image.yaml
+    permissions:
+      contents: read
+      packages: write
+

.github/workflows/publish-image.yaml

@@ -39,25 +39,50 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      - name: Extract metadata (tags, labels) for distribution image
-        id: metadist
+      - name: Extract metadata (branches)
+        id: meta-branch
+        if: ${{ !startsWith(github.ref, 'refs/tags/v') }}
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}
+          flavor: |
+            latest=false
+          tags: |
+            type=raw,value={{branch}},priority=1
+            type=raw,value=${{ env.IMAGE_NAME }}-{{branch}}-{{date 'YYYYMMDD'}}-{{sha}},priority=31
+
+      - name: Extract metadata (pre-release)
+        id: meta-pre
+        if: ${{ startsWith(github.ref, 'refs/tags/v') && contains(github.ref_name, '-') }}
+        uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
+        with:
+          images: ${{ env.REGISTRY }}/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}
+          flavor: |
+            latest=false
+          tags: |
+            type=semver,pattern={{version}},priority=2
+            type=raw,value={{version}},pattern={{version}},prefix=,priority=3
+            type=raw,value=${{ env.IMAGE_NAME }}-{{tag}}-{{date 'YYYYMMDD'}}-{{sha}},priority=32
+
+      - name: Extract metadata (stable)
+        id: meta-stable
+        if: ${{ startsWith(github.ref, 'refs/tags/v') && !contains(github.ref_name, '-') }}
         uses: docker/metadata-action@c1e51972afc2121e065aed6d45c65596fe445f3f # v5.8.0
         with:
           images: ${{ env.REGISTRY }}/${{ github.repository_owner }}/${{ env.IMAGE_NAME }}
           flavor: |
             latest=true
           tags: |
-            type=raw,value={{branch}},priority=1,enable=${{ !startsWith(github.ref, 'refs/tags/v') }}
             type=semver,pattern={{version}},priority=2
-            type=raw,value=${{ env.IMAGE_NAME }}-{{branch}}-{{date 'YYYYMMDD'}}-{{sha}},priority=31,enable=${{ !startsWith(github.ref, 'refs/tags/v') }}
-            type=raw,value=${{ env.IMAGE_NAME }}-{{tag}}-{{date 'YYYYMMDD'}}-{{sha}},priority=32, enable=${{ startsWith(github.ref, 'refs/tags/v') }}
+            type=semver,pattern={{major}}.{{minor}}.{{patch}},priority=3
+            type=raw,value=${{ env.IMAGE_NAME }}-{{tag}}-{{date 'YYYYMMDD'}}-{{sha}},priority=32
 
-      - name: Build and push distribution image
+      - name: Build and push image
         uses: docker/build-push-action@263435318d21b8e681c14492fe198d362a7d2c83 # v6.18.0
         with:
           context: .
           file: Containerfile
           platforms: linux/amd64
           push: true
-          tags: ${{ steps.metadist.outputs.tags }}
-          labels: ${{ steps.metadist.outputs.labels }}
+          tags: ${{ steps.meta-stable.outputs.tags || steps.meta-pre.outputs.tags || steps.meta-branch.outputs.tags }}
+          labels: ${{ steps.meta-stable.outputs.labels || steps.meta-pre.outputs.labels || steps.meta-branch.outputs.labels }}

.github/workflows/publish-package.yaml

@@ -21,16 +21,27 @@ jobs:
           node-version: "22.x"
           registry-url: "https://npm.pkg.github.com"
 
-      - name: Get latest tag
-        id: get_latest_tag
-        run: |
-          latest_tag=$(git describe --tags `git rev-list --tags --max-count=1`)
-          echo "LATEST_TAG=v${latest_tag}" >> $GITHUB_ENV
-
       - name: Install dependencies
         run: npm ci
 
-      - name: Publish package
+      - name: Publish prerelease
+        if: contains(github.ref_name, '-alpha.') || contains(github.ref_name, '-beta.') || contains(github.ref_name, '-rc.')
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+          if [[ "$TAG" =~ -alpha\. ]]; then DIST="alpha"; fi
+          if [[ "$TAG" =~ -beta\. ]];  then DIST="beta";  fi
+          if [[ "$TAG" =~ -rc\. ]];    then DIST="rc";    fi
+
+          echo "Publishing prerelease with dist-tag: $DIST"
+          npm publish --tag "$DIST"
+
+      # Stable → publicera som latest
+      - name: Publish stable
+        if: ${{ !contains(github.ref_name, '-') }}
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: npm publish --tag=${{ env.LATEST_TAG }}
+        run: |
+          echo "Publishing stable as latest"
+          npm publish

.github/workflows/workflow.yml

@@ -8,15 +8,38 @@ name: RAP-LP project Workflow
 on: # yamllint disable-line rule:truthy
   push:
     tags:
-      - "v[0-9]+.[0-9]+.[0-9]+"
+      - "v*.*.*"
+
 jobs:
+  gate:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    outputs:
+      ok: ${{ steps.chk.outputs.ok }}
+    steps:
+      - id: chk
+        shell: bash
+        run: |
+          if [[ "${GITHUB_REF_NAME}" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "ok=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "ok=false" >> "$GITHUB_OUTPUT"
+          fi
+
+  # Skapar en release tag som är stabil.
   publish-package:
+    needs: gate
+    if: needs.gate.outputs.ok == 'true'
     uses: ./.github/workflows/publish-package.yaml
     permissions:
       contents: read
       packages: write
+
   publish-image:
+    needs: [gate, publish-package]
+    if: needs.gate.outputs.ok == 'true'
     uses: ./.github/workflows/publish-image.yaml
     permissions:
       contents: read
-      packages: write
+      packages: write

CONTRIBUTING.md

@@ -89,7 +89,7 @@ För icke-triviala bidrag, vänligen diskutera med projektteamet först.
 
 Vi använder [Fork-and-Pull-modellen](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model):
 
-1. Forka repositoriet.
+1. Forka repositoriet från senaste release-tag.
 2. Skapa en ämnesgren från din forks huvudgren.
 3. Pusha dina ändringar till ämnesgrenen i din fork.
 4. Öppna en ny pull request till huvudprojektet.

README.md

@@ -5,8 +5,8 @@ SPDX-License-Identifier: CC0-1.0
 -->
 
 # REST API-profil - Lint Processor (RAP-LP)
+[![Tag](https://img.shields.io/github/v/tag/diggsweden/rest-api-profil-lint-processor?style=for-the-badge&sort=semver&filter=%21*-*&color=green)](https://github.com/diggsweden/rest-api-profil-lint-processor/tags)
 
-[![Tag](https://img.shields.io/github/v/tag/diggsweden/rest-api-profil-lint-processor?style=for-the-badge&color=green)](https://github.com/diggsweden/rest-api-profil-lint-processor/tags)
 
 [![License: EUPL 1.2](https://img.shields.io/badge/License-European%20Union%20Public%20Licence%201.2-library?style=for-the-badge&&color=lightblue)](LICENSE)
 [![REUSE](https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fapi.reuse.software%2Fstatus%2Fgithub.com%2Fdiggsweden%2Frest-api-profil-lint-processor&query=status&style=for-the-badge&label=REUSE&color=lightblue)](https://api.reuse.software/info/github.com/diggsweden/rest-api-profil-lint-processor)
@@ -25,6 +25,7 @@ RAP-LP är ett kommandoradsverktyg för att linta OpenAPI v3-definitioner med hj
   - [Innehållsförteckning](#innehållsförteckning)
   - [Installation och krav](#installation-och-krav)
   - [Instruktioner för att komma igång snabbt](#instruktioner-för-att-komma-igång-snabbt)
+  - [Versioner](#versioner)
   - [Användning](#användning)
   - [Begränsningar](#begränsningar)
   - [Support](#support)
@@ -38,7 +39,7 @@ RAP-LP är ett kommandoradsverktyg för att linta OpenAPI v3-definitioner med hj
 
 Det enklaste sättet att installera RAP-LP är genom att använda [npm](https://www.npmjs.com/):
 
-1. Klona ned projektet
+1. Klona ned projektet från senaste release, gärna via latest release tag.
 2. Installera alla beroenden:
 
 ```bash
@@ -59,6 +60,11 @@ npm start -- -f PATH_TO_THE_YAML_FILE
 npm start -- -f apis/dok-api.yaml
 ```
 
+## Versioner
+Senaste release tag ska alltid vara stabil och testad, vilket gör den till den föredragna versionen för att nyttja verktyget.
+
+Main och pre-releaser används med reservation för att all funktionalitet inte är garanterat stabil och testad.
+
 ## Användning
 
 För att validera mot en specifik kategori av regler, lägg till `-c CategoryName`.

apis/sak-api.yaml

@@ -116,17 +116,16 @@ components:
             write:pets: modify pets in your account
             read:pets: read your pets
     #Test for invalid types in security schemes
-    ApiKeyQuery: 
+    ApiKeyQuery:
       type: apiKey
       in: query
       name: api_key
     #Test for invalid types in security schemes
-    ApiKeyQuery2: 
+    ApiKeyQuery2:
       type: apiKey
       in: header
       name: api_key2
 
-
   schemas:
     Error:
       type: object

development/DEVELOPMENT.md

@@ -1,62 +1,127 @@
-# Development Guide
+# Utvecklingsguide
 
-This guide outlines core essentials for developing in this project.
+Denna guide beskriver de viktigaste grunderna för utveckling i detta projekt.
 
-## Table of Contents
-- [Setup and Configuration](#setup-and-configuration)
-  - [IDE Setup](#ide-setup)
-- [Development Workflow](#development-workflow)
-  - [Testing and Verification](#testing-format-and-lint)
-- [Release Process](#the-release-workflow)
-  - [CI Release](#ci-release-process)
-  - [Local Release](#local-release-process)
-  - [Troubleshooting](#troubleshooting)
+## Innehållsförteckning
+- [Installation och konfiguration](#installation-och-konfiguration)
+  - [IDE-inställningar](#ide-inställningar)
+- [Utvecklingsflöde](#utvecklingsflöde)
+  - [Testning och verifiering](#testning-och-verifiering)
+- [Releaseprocess](#releaseprocess)
+  - [CI-release](#ci-release)
+  - [Lokal release](#lokal-release)
+  - [Felsökning](#felsökning)
 
-## Setup and Configuration
+## Installation och konfiguration
 
-### IDE Setup
+### IDE-inställningar
 
 #### VSCode
 
 
 
-## Development Workflow
+## Utvecklingsflöde
 
-### Pull Request Workflow
+### Pull Request-flöde
 
-When submitting a PR, CI will automatically run several checks. To avoid surprises, run these checks locally first.
+När du skickar in en PR kommer CI automatiskt att köra flera kontroller. För att undvika överraskningar bör du köra dessa kontroller lokalt först.
 
-#### Prerequisites
+#### Förutsättningar
 - [Podman](https://podman.io/)
 
-#### Running Code Quality Checks Locally
+#### Köra kvalitetskontroller lokalt
 
-1. Run the quality check script:
+1. Kör kvalitetskontrollscriptet:
    ```shell
    ./development/code_quality.sh
    ```
-2. Fix any identified issues
-3. Update your PR with fixes
-4. Verify CI passes in the updated PR
+2. Åtgärda eventuella problem
+3. Uppdatera din PR med fixarna
+4. Verifiera att CI passerar i den uppdaterade PR:en
 
-#### Quality Check Details
+#### Detaljer för kvalitetskontroller
 
-- **Linting with megalinter**: BASH, Markdown, YAML, Typescript, GitHub Actions, security scanning
-- **License Compliance**: REUSE tool ensures proper copyright information
-- **Commit Structure**: Conform checks commit messages for changelog generation
-- **Dependency Analysis**: Scans for vulnerabilities, outdated packages, and license issues
-- **OpenSSF Scorecard**: Validates security best practices
+- **Lintning med megalinter**: BASH, Markdown, YAML, Typescript, GitHub Actions, säkerhetsskanning
+- **Licensöverensstämmelse**: REUSE-verktyget säkerställer korrekt copyright-information
+- **Commit-struktur**: Conform kontrollerar commit-meddelanden för changelog-generering
+- **Beroendeanalys**: Skannar efter sårbarheter, utdaterade paket och licensproblem
+- **OpenSSF Scorecard**: Validerar säkerhetsbästa praxis
 
-#### Handling Failed Checks
+#### Hantering av misslyckade kontroller
 
-If any checks fail in the CI pipeline:
+Om några kontroller misslyckas i CI-pipelinen:
 
-1. Review the CI error logs
-2. Run checks locally to reproduce the issues
-3. Make necessary fixes in your local environment
-4. Update your Pull Request
-5. Verify all checks pass in the updated PR
+1. Granska CI-fel-loggarna
+2. Kör kontrollerna lokalt för att återskapa problemen
+3. Gör nödvändiga fixar i din lokala miljö
+4. Uppdatera din Pull Request
+5. Verifiera att alla kontroller passerar i den uppdaterade PR:en
 
-## The Release Workflow
+## Releaseprocess
+Det finns ett arbetsflöde för att publicera images och paket antingen som en pre-release-version eller som en stabil release.
 
+### Pre-release
+Annotera pre-release-taggen med suffix och en version, använd suffix:
+- alpha → tidig testversion, ofta instabil
+- beta → mer testad, men fortfarande pre-release
+- rc → nära färdigställande, stabil release candidate
+
+X kan ersättas med vilken siffersekvens som helst bestående av 0–9.
+
+***Säkerställ att tagg-versionen matchar versionen i package.json och package-lock.json.***
+
+```
+git checkout <branch>
+git pull
+git tag -s -a vX.X.X-SUFFIX.x -m "vX.X.X-SUFFIX.X"
+git push origin vX.X.X-SUFFIX.X
+```
+
+Exempel:
+
+```
+git tag -s -a v1.0.3-alpha.1 -m "v1.0.3-alpha.1"
+git push origin v1.0.3-alpha.1
+```
+
+### Stabil release
+Checka ut main, hämta senaste ändringarna och tagga senaste commit på main.
+
+***Säkerställ att tagg-versionen matchar versionen i package.json och package-lock.json.***
+
+Checkout main, pull the latest changes and tag the latest main commit.
+
+```
+git checkout <branch>
+git pull
+git tag -s -a vX.X.X -m "vX.X.X"
+git push origin vX.X.X
+```
+
+Exempel:
+```
+git tag -s -a v1.0.0 -m "v1.0.0"
+git push origin v1.0.0
+```
+
+***På grund av projektbegränsningar är pre- och stabila releaser från main endast möjliga för admins!***
+
+### Släpp stabil version på GitHub
+1. Öppna [releases](https://github.com/diggsweden/rest-api-profil-lint-processor/releases) på GitHub.
+2. "Draft a new release"
+3. Välj vilken tagg som ska släppas
+4. Lägg till en release-titel – vX.X.X
+5. Lägg till en beskrivning eller generera release notes och rensa bort onödiga commits från beskrivningen
+6. Markera som senaste release
+7. Publicera releasen
+
+### Testa och verifiera release
+Efter varje release, pre- eller stabil, bör funktionaliteten testas och verifieras.
+
+Detta kan göras via stickprov av följande funktioner:
+
+#### Test av image
+Kör följande kommandon med den version av verktyget du vill testa – [använd podman/docker](../README.md#användning-via-podmandocker)
+
+### Test av npm-paket
 ...