lukaszraczylo/semver-generator
1
0
Fork 0
mirror of https://github.com/lukaszraczylo/semver-generator.git synced 2026-07-12 04:40:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation with docker and supported architectures for binaries and images.

Browse Source
This commit is contained in:
Lukasz Raczylo
2021-05-09 21:13:56 +01:00
parent af71c23260
commit 42c880f904
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+17
View File
@@ -9,6 +9,7 @@ Project created overnight, to prove that management of semantic versioning is NO
- [Usage](#usage) - [Usage](#usage)
- [As a binary](#as-a-binary) - [As a binary](#as-a-binary)
- [As a github action](#as-a-github-action) - [As a github action](#as-a-github-action)
- [As a docker container](#as-a-docker-container)
- [Calculations example](#calculations-example) - [Calculations example](#calculations-example)
- [Example configuration](#example-configuration) - [Example configuration](#example-configuration)
- [Good to know](#good-to-know) - [Good to know](#good-to-know)
@@ -23,6 +24,11 @@ Project created overnight, to prove that management of semantic versioning is NO
#### As a binary #### As a binary
You can download latest versions of the binaries from the [release page](https://github.com/lukaszraczylo/semver-generator/releases/latest).
**Supported OS and architectures:**
Darwin ARM64/AMD64, Linux ARM64/AMD64, Windows AMD64
```bash ```bash
bash$ ./semver-gen generate -r https://github.com/nextapps-de/winbox bash$ ./semver-gen generate -r https://github.com/nextapps-de/winbox
SEMVER 9.0.10 SEMVER 9.0.10
@@ -43,9 +49,11 @@ Available Commands:
Flags: Flags:
-c, --config string Path to config file (default "config.yaml") -c, --config string Path to config file (default "config.yaml")
-d, --debug Enable debug mode
-h, --help help for semver-gen -h, --help help for semver-gen
-l, --local Use local repository -l, --local Use local repository
-r, --repository string Remote repository URL. (default "https://github.com/lukaszraczylo/simple-gql-client") -r, --repository string Remote repository URL. (default "https://github.com/lukaszraczylo/simple-gql-client")
-v, --version Display version
``` ```
#### As a github action #### As a github action
@@ -76,6 +84,15 @@ jobs:
echo "Semantic version detected: ${{ steps.semver.outputs.semantic_version }}" echo "Semantic version detected: ${{ steps.semver.outputs.semantic_version }}"
``` ```
#### As a docker container
```bash
docker pull ghcr.io/lukaszraczylo/semver-generator:latest
```
**Docker supported architectures:**
Linux/arm64, Linux/amd64
#### Calculations example #### Calculations example
* 0.0.1 - PATCH - starting commit * 0.0.1 - PATCH - starting commit