Skip to content

Commit 08424e1

Browse files
docs: move release process to wiki
Signed-off-by: Nicklas Silversved <nicklas.silversved@digg.se>
1 parent 41df17f commit 08424e1

File tree

2 files changed

+23
-75
lines changed

2 files changed

+23
-75
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,7 @@ Förutsätter att det finns en `openapi.yaml` att validera i den aktuella katalo
4242

4343
### NPM
4444
> Notera: Att GitHub Packages (npm) kräver authentisering.<br>
45-
> Projektets `.npmrc` bör vara konfigurerat mot rätt registry - `@diggsweden:registry=https://npm.pkg.github.com`
46-
47-
48-
```bash
49-
npm login --registry=https://npm.pkg.github.com
50-
# username: ditt GitHub-användarnamn
51-
# password: GitHub PAT med read:packages
52-
```
53-
45+
> Projektets `.npmrc` bör vara konfigurerat mot rätt registry - `@diggsweden:registry=https://npm.pkg.github.com`<br>
5446
> Om du saknar inloggning med GitHub Personal access token (PAT), se [FAQ](#hur-skapar-jag-ett-github-personal-access-token-pat).
5547
5648
> Notera: Att `<version>` byts ut mot önskad version av verktyget, oftast senaste release tag. För mer information se [versioner](#versioner).
@@ -87,6 +79,8 @@ Kör utan installation och package.json:
8779
npx @diggsweden/rest-api-profil-lint-processor@<version> -f openapi.yaml
8880
```
8981

82+
> Notera: Att npx laddar ned paketet till en tillfällig cache-mapp om det inte redan finns en version i node_modules/.bin
83+
9084
### Podman
9185
Kör med podman:
9286
```bash
@@ -114,8 +108,24 @@ npm start -- -f openapi.yaml
114108
> Notera: Att alla kommandon lokalt körs med `npm start --`.
115109
116110
## Versioner
117-
Senaste release tag ska alltid vara stabil och testad, vilket gör den till den föredragna versionen för att nyttja verktyget.<br>
118-
Main och pre-releaser används med reservation för att all funktionalitet inte är garanterat stabil och testad.
111+
Main-branchen, feature-brancher, pre-release- och testversioner används med reservation för att de kan innehålla funktionalitet som inte är garanterad att den är testad på samma sätt som en stabil version.
112+
113+
**Stabila versioner**<br>
114+
[Release](https://github.com/diggsweden/rest-api-profil-lint-processor/releases) ska alltid vara stabil och testad, vilket gör den till den föredragna versionen för att nyttja verktyget.<br>
115+
Dessa versioner är taggade med `vX.X.X` utan något suffix.
116+
117+
**Pre-release- och testversioner**<br>
118+
Pre-release-versioner är taggade med följande suffix:
119+
- alpha → tidig testversion, ofta instabil
120+
- beta → mer testad, men fortfarande pre-release
121+
- rc → nära färdigställande, stabil release candidate
122+
123+
Rena testversioner är taggade med `vX.X.X-dev` följt av namnet på den branchen.<br>
124+
Dessa versioner är byggda för att testa funktionalitet som är under utveckling.
125+
126+
Alla versioner av verktyget hittar du här:
127+
- [Container Image](https://github.com/diggsweden/rest-api-profil-lint-processor/pkgs/container/rest-api-profil-lint-processor)
128+
- [NPM Package](https://github.com/diggsweden/rest-api-profil-lint-processor/pkgs/npm/rest-api-profil-lint-processor)
119129

120130
## Användning
121131
Här beskrivs vilka användningsområden verktyget har med diverse flaggor som kan sättas för att nyttja verktygets funktionalitet.
@@ -161,6 +171,7 @@ raplp -f openapi.yaml -c DokRules,AmeRules,SakRules
161171
- FelRules
162172
- FnsRules
163173
- ForRules
174+
- ResRules
164175
- SakRules
165176
- UfnRules
166177
- VerRules

development/DEVELOPMENT.md

Lines changed: 1 addition & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ Denna guide beskriver de viktigaste grunderna för utveckling i detta projekt.
88
- [Utvecklingsflöde](#utvecklingsflöde)
99
-[Pull Request-flöde](#pull-request-flöde)
1010
- [Releaseprocess](#releaseprocess)
11-
- [Utveckling](#release-för-utveckling)
12-
- [Produktion](#release-för-produktion)
1311
- [Testa och verifiera](#testa-och-verifiera)
1412
- [Eventuella hinder](#eventuella-hinder)
1513

@@ -74,68 +72,7 @@ Om några kontroller misslyckas i CI-pipelinen:
7472
5. Verifiera att alla kontroller passerar i den uppdaterade PR:en
7573

7674
## Releaseprocess
77-
Det finns två olika workflows för att göra en ny release, antingen för en feature under utveckling eller för produktion.
78-
79-
- [Utveckling](../.github/workflows/release-dev-workflow.yml)
80-
- [Produktion](../.github/workflows/release-workflow.yml)
81-
82-
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>
83-
Projektets releaser bygger på en gemensam struktur för DiggSweden vilken innefattar säkerhetsrutiner, automatiserade releaser och kvalitetskontroller. <br>
84-
För mer information se [Reusable CI/CD Workflows](https://github.com/diggsweden/reusable-ci?tab=readme-ov-file#reusable-cicd-workflows).
85-
86-
### Release för utveckling
87-
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.
88-
89-
> **Utvecklingsreleaser kommer ***INTE*** generera och uppdatera changelog, release notes eller göra en ny release i GitHub.**
90-
91-
### Release för produktion
92-
Vid release till produktion kan man välja om man vill släppa det som en pre-release version eller som en stabil version.
93-
94-
> **Produktionsreleaser kommer automatiskt generera och uppdatera changelog, release notes och göra en ny release i GitHub.**
95-
96-
#### Pre-release
97-
Annotera pre-release-taggen med suffix och en version, använd suffix:
98-
- alpha → tidig testversion, ofta instabil
99-
- beta → mer testad, men fortfarande pre-release
100-
- rc → nära färdigställande, stabil release candidate
101-
102-
X kan ersättas med vilken siffersekvens som helst bestående av 0–9.
103-
104-
***Säkerställ att tagg-versionen matchar versionen i package.json och package-lock.json.***
105-
106-
```
107-
git checkout <branch>
108-
git pull
109-
git tag -s -a vX.X.X-SUFFIX.x -m "vX.X.X-SUFFIX.X"
110-
git push origin vX.X.X-SUFFIX.X
111-
```
112-
113-
Exempel:
114-
115-
```
116-
git tag -s -a v1.0.3-alpha.1 -m "v1.0.3-alpha.1"
117-
git push origin v1.0.3-alpha.1
118-
```
119-
120-
#### Stabil release
121-
Checka ut main, hämta senaste ändringarna och tagga senaste commit på main.
122-
123-
***Säkerställ att tagg-versionen matchar versionen i package.json och package-lock.json.***
124-
125-
```
126-
git checkout <branch>
127-
git pull
128-
git tag -s -a vX.X.X -m "vX.X.X"
129-
git push origin vX.X.X
130-
```
131-
132-
Exempel:
133-
```
134-
git tag -s -a v1.0.0 -m "v1.0.0"
135-
git push origin v1.0.0
136-
```
137-
138-
***På grund av projektbegränsningar är pre- och stabila releaser från main endast möjliga för admins!***
75+
Releaseprocessen hanteras automatiskt av maintainer-teamet via intern dokumentation.
13976

14077
## Testa och verifiera
14178
Efter varje release, pre- eller stabil, bör funktionaliteten testas och verifieras.

0 commit comments

Comments
 (0)