Skip to content

Commit 41df17f

Browse files
docs: replace latest with <version>
Signed-off-by: Nicklas Silversved <nicklas.silversved@digg.se>
1 parent 99ed3d7 commit 41df17f

File tree

2 files changed

+16
-13
lines changed

2 files changed

+16
-13
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,11 @@ npm login --registry=https://npm.pkg.github.com
5353

5454
> Om du saknar inloggning med GitHub Personal access token (PAT), se [FAQ](#hur-skapar-jag-ett-github-personal-access-token-pat).
5555
56+
> Notera: Att `<version>` byts ut mot önskad version av verktyget, oftast senaste release tag. För mer information se [versioner](#versioner).
57+
5658
#### Installera globalt med npm:
5759
```bash
58-
npm i -g @diggsweden/rest-api-profil-lint-processor@latest
60+
npm i -g @diggsweden/rest-api-profil-lint-processor@<version>
5961
raplp -f openapi.yaml
6062
```
6163

@@ -64,7 +66,7 @@ raplp -f openapi.yaml
6466
Installera och lägg som `devDependencies`:
6567

6668
```
67-
npm i --save-dev @diggsweden/rest-api-profil-lint-processor@latest
69+
npm i --save-dev @diggsweden/rest-api-profil-lint-processor@<version>
6870
```
6971

7072
Lägg till ett [`npm run` script](https://docs.npmjs.com/cli/run-script) i din `package.json` med rätt sökväg till filen du vill validera:
@@ -82,19 +84,19 @@ Nu kan du använda `npm run lint-processor`.
8284
### NPX
8385
Kör utan installation och package.json:
8486
```bash
85-
npx @diggsweden/rest-api-profil-lint-processor@latest -f openapi.yaml
87+
npx @diggsweden/rest-api-profil-lint-processor@<version> -f openapi.yaml
8688
```
8789

8890
### Podman
8991
Kör med podman:
9092
```bash
91-
podman run --rm -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest -f /data/openapi.yaml
93+
podman run --rm -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version> -f /data/openapi.yaml
9294
```
9395

9496
### Docker
9597
Kör med docker:
9698
```bash
97-
docker run --rm -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest -f /data/openapi.yaml
99+
docker run --rm -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version> -f /data/openapi.yaml
98100
```
99101
> Notera: Sökvägar kan hanteras olika beroende på miljö:
100102
> - Podman (Linux/macOS/WSL): -v $(pwd):/app/example
@@ -295,7 +297,8 @@ podman login ghcr.io
295297

296298
## Bidra
297299

298-
Om du vill bidra till projektet, vänligen följ instruktionerna i avsnittet [Contributing](CONTRIBUTING.md).
300+
Om du vill bidra till projektet, vänligen följ instruktionerna i avsnittet [Contributing](CONTRIBUTING.md).<br>
301+
För utvecklare finns det mer information i avsnittet [Development](development/DEVELOPMENT.md).
299302

300303
## Utveckling
301304

development/DEVELOPMENT.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -143,22 +143,22 @@ Efter varje release, pre- eller stabil, bör funktionaliteten testas och verifie
143143
### Testa mot publicerat npm paket
144144
Kör följande kommando mot den version av verktyget som ska testas:
145145
```bash
146-
npx @diggsweden/rest-api-profil-lint-processor@latest -f openapi.yaml -l raplp.log --dex avstamning.xlsx
146+
npx @diggsweden/rest-api-profil-lint-processor@<version> -f openapi.yaml -l raplp.log --dex avstamning.xlsx
147147
```
148148

149149
---
150150

151151
#### Test av image med podman/docker
152152
Kör följande kommandon med den version av verktyget som ska testas:
153153
```bash
154-
podman run -it -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest -f /data/openapi.yaml -l /data/raplp.log --dex /data/avstamning.xlsx
154+
podman run -it -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version> -f /data/openapi.yaml -l /data/raplp.log --dex /data/avstamning.xlsx
155155
```
156156

157157
> För alla kommandon bör ***podman*** kunna ersättas med ***docker*** om så önskas.
158158
159159
I en terminal kör:
160160
```bash
161-
podman run --rm -it -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest -f /data/openapi.yaml
161+
podman run --rm -it -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version> -f /data/openapi.yaml
162162
```
163163
* Där data motsvarar den katalog i containern som du vill att nuvarande katalog \$(pwd) mountas in i, containern får tillgång till dina filer i \$(pwd).
164164
* Där `openapi.yaml` motsvarar den filen som du vill applicera valideringen på.
@@ -171,7 +171,7 @@ I en terminal kör:
171171
172172
Exempel
173173
```bash
174-
podman run --rm -it -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest -f /data/openapi.yaml -l /data/raplp.log --dex /data/avstamning.xlsx
174+
podman run --rm -it -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version> -f /data/openapi.yaml -l /data/raplp.log --dex /data/avstamning.xlsx
175175
```
176176

177177
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.<br>
@@ -180,7 +180,7 @@ Se till att containern har rättigheter att skriva till den katalog som du mount
180180
#### Alternativ att köra ifrån containern
181181
1. Starta en podman container:
182182
```bash
183-
podman run --rm -it --entrypoint /bin/sh -v $(pwd):/app/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest
183+
podman run --rm -it --entrypoint /bin/sh -v $(pwd):/app/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version>
184184
```
185185
2. Kör din validering ifrån containern:
186186
```bash
@@ -190,7 +190,7 @@ Se till att containern har rättigheter att skriva till den katalog som du mount
190190

191191
Exempel:
192192
```bash
193-
podman run --rm -it --entrypoint /bin/sh -v $(pwd):/app/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest
193+
podman run --rm -it --entrypoint /bin/sh -v $(pwd):/app/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version>
194194
195195
/app: npm start -- -f data/openapi.yaml -l data/raplp.log --dex data/avstamning.xlsx # skriver till din nuvarande katalog
196196
```
@@ -213,6 +213,6 @@ Du kan behöva ett Personal Access Token (PAT) för din användare i github för
213213
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.
214214
4. Du kan även prova:
215215
```bash
216-
sudo podman run -it -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:latest -f /data/openapi.yaml -l /data/raplp.log --dex /data/avstamning.xlsx
216+
sudo podman run -it -v $(pwd):/data ghcr.io/diggsweden/rest-api-profil-lint-processor:<version> -f /data/openapi.yaml -l /data/raplp.log --dex /data/avstamning.xlsx
217217
```
218218

0 commit comments

Comments
 (0)