Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# BSI Secvisogram CSAF Validator Service

<!-- TOC depthfrom:2 depthto:3 -->

- [About the project](#about-the-project)
- [Getting started](#getting-started)
- [Documentation](#documentation)
Expand All @@ -10,11 +11,14 @@
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Run server](#run-server)
- [Generate documentation](#generate-documentation)
- [Create new version](#create-new-version)
- [Testing](#testing)
- [Docker](#docker)
- [Persist with pm2](#persist-with-pm2)
- [Contributing](#contributing)
- [Dependencies](#dependencies)

<!-- /TOC -->

## About the project
Expand Down Expand Up @@ -104,6 +108,14 @@ openapi-generator-cli generate -i http://localhost:8082/docs/json -g asciidoc -o

[(back to top)](#bsi-secvisogram-csaf-validator-service)

### Create new version

Make sure, you have the package [@openapitools/openapi-generator-cli](https://www.npmjs.com/package/@openapitools/openapi-generator-cli) installed globally (using `npm i -g @openapitools/openapi-generator-cli`).

To create a new version use npm's [version](https://docs.npmjs.com/cli/v11/commands/npm-version) command and make sure that your server is not running (since this command will start it).

[(back to top)](#bsi-secvisogram-csaf-validator-service)

## Testing

Many tests are integration tests which need a running server. So make sure to start it before running the tests:
Expand Down
Loading