Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gowizzard/compver
An little cli tool to compare or get a core block of versions. Based on semantic versioning.
https://github.com/gowizzard/compver
actions cli compare flags github go golang hacktoberfest sementic semver versioning versions
Last synced: 3 months ago
JSON representation
An little cli tool to compare or get a core block of versions. Based on semantic versioning.
- Host: GitHub
- URL: https://github.com/gowizzard/compver
- Owner: gowizzard
- License: mit
- Created: 2022-08-04T16:06:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-01T08:15:33.000Z (over 1 year ago)
- Last Synced: 2024-09-21T19:31:00.472Z (4 months ago)
- Topics: actions, cli, compare, flags, github, go, golang, hacktoberfest, sementic, semver, versioning, versions
- Language: Go
- Homepage: https://hub.docker.com/r/gowizzard/compver
- Size: 220 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# CompVer
[](https://golang.org/) [](https://github.com/gowizzard/compver/actions/workflows/go-test.yml) [](https://github.com/gowizzard/compver/actions/workflows/docker-test.yml) [](https://github.com/gowizzard/compver/actions/workflows/codeql.yml) [](https://github.com/gowizzard/compver/actions/workflows/docker-build.yml) [](https://github.com/gowizzard/compver/actions/workflows/compver.yml) [](https://github.com/gowizzard/compver/actions/workflows/assets.yml) [](https://pkg.go.dev/github.com/gowizzard/compver/v5) [](https://goreportcard.com/report/github.com/gowizzard/compver/v5) [](https://github.com/gowizzard/compver/issues) [](https://github.com/gowizzard/compver/network) [](https://github.com/gowizzard/compver/stargazers) [](https://github.com/gowizzard/compver/blob/master/LICENSE)
With this small cli tool, you can compare two versions with each other. Or perform other operations around the version number. **Currently, it is important to know that we only compare the version core `x.y.z`.** This means that currently the pre-releases and the meta information are not taken into account. But you can read pre-releases and metadata from a version using our tool. For this you can use the core command.
Our version specifications are based on semantic versioning. [Here](https://semver.org/) you can find the corresponding definition. So that major, minor and patch can be read correctly, we use regex. You can find [here](https://regex101.com/r/un81dE/5) at regex101 once the used expression.
## Installation
### go install
If you have Go installed on your local machine, you can install the tool via the following command.
```bash
go install github.com/gowizzard/compver/v5@latest
```
### Install binary
If you don't want to install Go on your local machine, you can also use the binary. In order to install the tool correctly, you need to download it [here](https://github.com/gowizzard/compver/releases) and make it executable. After that you can move the binary into the application folder and use it via the terminal.
```bash
# Download the binary
curl -L -o compver https://github.com/gowizzard/compver/releases/latest/download/compver--
# Make the binary executable
chmod +x compver
# Move to application directory
sudo mv compver /usr/local/bin
```
## How to use
Here you can find the different statements you can use.
### Compare versions
Actually, you don't need to know much to execute the command. You actually only compare the newest version with the older version. We assume that `VERSION1` is the newer version and `VERSION2` is the older one. But downgrades of versions can also be recorded.
```bash
compver -compare -version1 -version2
```
If this command is executed now, we get an information back, this can contain the following information: `no changes`, `major update`, `major downgrade`, `minor update`, `minor downgrade`, `patch update` & `patch downgrade`.
### Get version core block
If you want to read a block of the version core, you can do this with the following command. You will receive the number of the block as an answer. You can read and return the blocks `major`, `minor`, `patch`, `prerelease` and `buildmetadata`.
```bash
compver -core -block major -version1
```
### Trim prefix
So that you can also read versions that do not directly correspond to the semantic versioning, we have added the trim function. So you can also read and compare a version with a preceding `v` by calling the prefix with the trim command as follows.
```bash
compver -core -block minor -version1 -trim -prefix
```
## Using the GitHub Action
Here you can find an example if you want to use CompVer as a GitHub Action. In the example the action is only triggered when a new release is created.
I use this example a lot when I need to maintain major branches. Especially when developing Golang libraries this is very important. The action takes the release version and determines the major block of the version core. Then the version branch, for example `v3`, is merged with the default branch, so that the version branch is always up-to-date. So you only have to create the branch once and don't have to worry about it not being maintained.
```yaml
name: CompVer
on:
push:
tags:
- "v*.*.*"
env:
USER_NAME: "GitHub Action"
USER_EMAIL: "[email protected]"
DEFAULT_BRANCH: ${{ github.event.repository.default_branch }}
COMMIT_MESSAGE: "ci: The data of the master branch was merged automatically."
jobs:
version:
runs-on: ubuntu-latest
steps:
- name: Clone repository
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Get the major version
id: compver
env:
GITHUB_TOKEN: ${{ github.token }}
uses: gowizzard/compver@v5
with:
args: "-core -block major -version1 ${{ github.ref_name }} -trim -prefix v"
- name: Set git config
run: |
git config --local user.name "$USER_NAME"
git config --local user.email "$USER_EMAIL"
- name: Merge data from default branch
run: |
git fetch
git checkout v${{ steps.compver.outputs.core_result }}
git pull
git merge --no-ff "origin/$DEFAULT_BRANCH" -m "$COMMIT_MESSAGE"
git push
```
## Special thanks
Thanks to [JetBrains](https://github.com/JetBrains) for supporting me with this and other [open source projects](https://www.jetbrains.com/community/opensource/#support).