docs: improve documentation for readme and development

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

Author: brorlarsnicklas

README.md

@@ -51,7 +51,7 @@ npm install
 Använd det här kommandot för att köra applikationen mot en YAML-fil:
 
 ```bash
-npm start -- -f PATH_TO_THE_YAML_FILE
+npm start -- -f <PATH>/<YAML_FILE>
 ```
 
 **Exempel**
@@ -67,7 +67,7 @@ Main och pre-releaser används med reservation för att all funktionalitet inte
 
 ## Användning
 
-För att validera mot en specifik kategori av regler, lägg till `-c CategoryName`.
+För att validera mot en specifik kategori av regler, lägg till `-c <CategoryName>`.
 
 ### Validering med utvalda regler
 **Exempel**
@@ -89,7 +89,7 @@ npm start -- -f apis/dok-api.yaml -c DokRules
 - UfnRules
 - VerRules
 
-För att spara meddelanden från felloggar, lägg till `-l FileName`.
+För att spara meddelanden från felloggar, lägg till `-l <FILE>`.
 
 
 ### Validering som skriver resultat till en valfri logfil
@@ -109,7 +109,7 @@ npm start -- -f apis/dok-api.yaml -l rap-lp.log -a
 ```
 
 ### Validering som sparar loggdiagnostik i en fil
-För att spara loggdiagnostik i en fil, lägg till `-d FileName`
+För att spara loggdiagnostik i en fil, lägg till `-d <FILE>`
 
 **Exempel**
 
@@ -134,7 +134,7 @@ npm start -- -f apis/dok-api.yaml --dex
 **Exempel med sökväg till avstämningsfil i Excel**
 
 ```bash
-npm start -- -f apis/dok-api.yaml --dex path-to-excel-file
+npm start -- -f apis/dok-api.yaml --dex <PATH>
 ```
 
 ### Visa information version
@@ -152,8 +152,32 @@ npm start -- --version
 npm start -- --help
 ```
 
+### Testa mot publicerat npm paket
+> OBS se till så att .npmrc verkligen är konfigurerat mot @diggsweden:registry=https://npm.pkg.github.com
+
+För att köra mot ett **publicerat** paket istället för lokala byggen, se [npm paket](https://github.com/diggsweden/rest-api-profil-lint-processor/pkgs/npm/rest-api-profil-lint-processor) för version och använd:
+
+
+```bash
+npm login --registry=https://npm.pkg.github.com
+# username: ditt GitHub-användarnamn
+# password: GitHub PAT med read:packages
+```
+
+> Om du saknar inloggning med GitHub PAT, se [Access till registry](#access-till-registry)
+
+Kör sedan: 
+```bash
+# npx @diggsweden/rest-api-profil-lint-processor@1.0.0 -f openapi-test.yaml -l rap-lp.log -d avstamning.xlsx
+npx @diggsweden/rest-api-profil-lint-processor@1.0.0 -f <PATH>/<YAML_FILE>
+``` 
+
+---
+
 ### Användning via podman/docker
 
+> För alla kommandon bör ***podman*** kunna ersättas med ***docker*** om så önskas.
+
 I en terminal kör:
   ```bash
   podman run --rm -it -v $(pwd):/<PATH> ghcr.io/diggsweden/rest-api-profil-lint-processor:<VERSION X.X.X> -f <PATH>/<YAML_FILE>
@@ -164,7 +188,7 @@ I en terminal kör:
 
 Exempel
   ```bash
-  podman run -it -v $(pwd):/app/example ghcr.io/diggsweden/rest-api-profil-lint-processor:1.0.0 -f example/dot-api.yaml -l example/test.log --dex example/avstamning.xlsx
+  podman run -it -v $(pwd):/app/example ghcr.io/diggsweden/rest-api-profil-lint-processor:1.0.0 -f example/dot-api.yaml -l example/rap-lp.log --dex example/avstamning.xlsx
   ```
 
 Vid eventuella fel och du inte hittar rap-lp-error.log kan du behöva köra kommandot via containern enligt den alternativa instruktionen nedan. Se till att containern har rättigheter att skriva till den katalog som du mountar, se [Skrivåtkomst till mount från container](#skrivåtkomst-till-mount-från-container).
@@ -180,7 +204,7 @@ Exempel:
   ```bash
   $ podman run --rm -it --entrypoint /bin/sh -v $(pwd):/apis ghcr.io/diggsweden/rest-api-profil-lint-processor:0.3.0
 
-  /app: $ npm start -- -f apis/dot-api.yaml -l test.log --dex example.xlsx
+  /app: $ npm start -- -f apis/dot-api.yaml -l rap-lp.log --dex example.xlsx
   ```
 
 ### Eventuella hinder med podman-kommando
@@ -209,7 +233,7 @@ Du kan behöva ett Personal Access Token (PAT) för din användare i github för
 3. Beroende på din miljö och vilka möjligheter du har, hantera åtkomstproblemet mer beständigt och återställ tidigare läs- och skrivrättigheter.
 4. Du kan även prova:  
     ```bash
-    sudo podman run -it -v $(pwd):/app/example ghcr.io/diggsweden/rest-api-profil-lint-processor:1.0.0 -f example/dot-api.yaml -l example/test.log --dex example/avstamning.xlsx
+    sudo podman run -it -v $(pwd):/app/example ghcr.io/diggsweden/rest-api-profil-lint-processor:1.0.0 -f example/dot-api.yaml -l example/rap-lp.log --dex example/avstamning.xlsx
     ```
 
 ### Riktlinjer och förklaringar

development/DEVELOPMENT.md

@@ -24,7 +24,8 @@ Denna guide beskriver de viktigaste grunderna för utveckling i detta projekt.
 
 ### Pull Request-flöde
 
-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.
+När du skickar in en PR kommer CI automatiskt att köra flera kontroller.<br/>
+För att undvika överraskningar bör du köra dessa kontroller lokalt först.
 
 #### Förutsättningar
 - [Podman](https://podman.io/)
@@ -58,9 +59,26 @@ Om några kontroller misslyckas i CI-pipelinen:
 5. Verifiera att alla kontroller passerar i den uppdaterade PR:en
 
 ## Releaseprocess
-Det finns ett arbetsflöde för att publicera images och paket antingen som en pre-release-version eller som en stabil release.
+Det finns två olika workflows för att göra en ny release, antingen för en feature under utveckling eller för produktion.
 
-### Pre-release
+- [Utveckling](../.github/workflows/release-dev-workflow.yml)
+- [Produktion](../.github/workflows/release-workflow.yml)
+
+För varje ny release kommer det bland annat att det byggas en docker image och ett npm paket som kan hämtas hem och köras. <br>
+Projektets releaser bygger på en gemensam struktur för DiggSweden vilken innefattar säkerhetsrutiner, automatiserade releaser och kvalitetskontroller. <br>
+För mer information se [Reusable CI/CD Workflows](https://github.com/diggsweden/reusable-ci?tab=readme-ov-file#reusable-cicd-workflows).
+
+### Release för utveckling
+Genom att pusha till en branch med prefix **dev/** eller **feat/** skapas en utvecklingsrelease vilket möjliggör tester av paket och images innan produktion.
+
+> **Utvecklingsreleaser kommer ***INTE*** generera och uppdatera changelog, release notes eller göra en ny release i GitHub.**
+
+### Release för produktion
+Vid release till produktion kan man välja om man vill släppa det som en pre-release version eller som en stabil version.
+
+> **Produktionsreleaser kommer automatiskt generera och uppdatera changelog, release notes och göra en ny release i GitHub.**
+
+#### 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
@@ -84,13 +102,11 @@ 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
+#### 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
@@ -106,22 +122,19 @@ 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)
+```bash
+# EXEMPEL: podman run -it -v $(pwd):/app/example ghcr.io/diggsweden/rest-api-profil-lint-processor:1.0.0 -f example/dot-api.yaml -l example/rap-lp.log --dex example/avstamning.xlsx
+podman run --rm -it -v $(pwd):/<PATH> ghcr.io/diggsweden/rest-api-profil-lint-processor:<VERSION X.X.X> -f <PATH>/<YAML_FILE>
+```
+#### Test av npm-paket
+Kör följande kommandon med den version av verktyget du vill testa – [använd node](../README.md#användning)
+```bash
+# EXEMPEL: npx @diggsweden/rest-api-profil-lint-processor@1.0.0 -f openapi-test.yaml -l rap-lp.log -d avstamning.xlsx
+npx @diggsweden/rest-api-profil-lint-processor@1.0.0 -f <PATH>/<YAML_FILE>
+```
 
-### Test av npm-paket
-...