Skip to content

Commit 48df229

Browse files
committed
docs: updates readme
1 parent eeea4a5 commit 48df229

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,32 @@
77

88
A [semantic-release](https://github.com/semantic-release/semantic-release) plugin to use semantic versioning for docker images.
99

10-
## verifyConditions
10+
## Supported Steps
11+
12+
### verifyConditions
1113

1214
verifies that environment variables for authentication via username and password are set.
1315
It uses a registry server provided via config or environment variable (preferred) or defaults to docker hub if none is given.
1416
It also verifies that the credentials are correct by logging in to the given registry.
1517

16-
## prepare
18+
### prepare
1719

1820
tags the specified image with the version number determined by semantic-release and additional tags provided in the configuration.
1921
In addition it supports specifying a complete image name (CIN) via configuration settings according to the canonical format specified by docker:
2022

2123
`[registryhostname[:port]/][username/]imagename[:tag]`
2224

23-
## publish
25+
### publish
2426

2527
pushes the tagged images to the registry.
2628

29+
## Installation
30+
31+
Run `npm i --save-dev @iteratec/semantic-release-docker` to install this semantic-release plugin.
32+
2733
## Configuration
2834

29-
### docker registry authentication
35+
### Docker registry authentication
3036

3137
The `docker registry` authentication is **required** and can be set via environment variables.
3238

@@ -47,7 +53,7 @@ The `docker registry` authentication is **required** and can be set via environm
4753
| registryUrl | _Optional_. The hostname and port used by the the registry in format `hostname[:port]`. Omit the port if the registry uses the default port |
4854
| repositoryName | _Optional_. The name of the repository in the registry, e.g. username on docker hub |
4955

50-
### Usage
56+
## Usage
5157

5258
full configuration:
5359

0 commit comments

Comments
 (0)