Skip to content
This repository has been archived by the owner on Jun 14, 2023. It is now read-only.

Commit

Permalink
Merge pull request #20 from postfinance/feature/semantic-release
Browse files Browse the repository at this point in the history
docs: enhance developer documentation
  • Loading branch information
bbortt authored Sep 26, 2022
2 parents 34187dc + 474236c commit fc667be
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 3 deletions.
7 changes: 4 additions & 3 deletions DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,13 @@ the available types.

### `semantic-release`

The pipeline uses [`semantic-release`](https://github.com/semantic-release/semantic-release/) internally. Take a look at
The pipeline uses the npm package [`semantic-release`](https://github.com/semantic-release/semantic-release/)
internally. Take a look at
the [`release`-workflow](https://github.com/postfinance/polling-swagger-ui/blob/release/.github/workflows/release.yaml)
or
[the official documentation](https://github.com/semantic-release/github/) in order to get started.
[the official documentation](https://github.com/semantic-release/github/) if you want to know more about it.

An access token (`GITHUB_TOKEN`) with the following scope is required for `semantic-release` to work properly: `public_repo`
Also, note that it uses the default `GITHUB_TOKEN` for interacting with GitHub.
.

## Docker Tagging
Expand Down
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,11 @@ Polling Swagger-UI

* [Configuration](#configuration)
* [Docker Container](#docker-container)
* [Node.js](#nodejs)
* [Swagger](#swagger)
* [Running the Container](#running-the-container)
* [Contributing](#contributing)
* [License](#license)

# Configuration

Expand Down Expand Up @@ -69,6 +72,12 @@ docker run \
postfinance/polling-swagger-ui:1.0.0
```

# Contributing

Contributors may find help in
the [`DEVELOPMENT.md`](https://github.com/postfinance/polling-swagger-ui/blob/release/DEVELOPMENT.md). It contains
useful resources on how to behave when contributing, so we can accept your pull-requests without big trouble 😉

# License

This project is licensed under the terms of
Expand Down

0 comments on commit fc667be

Please sign in to comment.