Skip to content

Commit 435b7c6

Browse files
psycho0verloadpsycho0verload
committed
Docu: Add Documentation
1 parent 300d66d commit 435b7c6

6 files changed

+134
-2
lines changed

‎README.md‎

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,34 @@ The generated version in SemVer format, depending on the provided parameters:
6868

6969
## Usage Examples
7070

71-
### Basic Version Bumps
71+
### Basic Exampple
7272

7373
```yaml
7474
- uses: psycho0verload/increment-version@latest
7575
with:
7676
current-version: '1.2.3'
7777
version-type: 'major'
7878
```
79-
The Basic example is the simplest form of usage. The expected result is: `2.0.0`.
79+
The Basic example is the simplest form of usage. The expected result is: `2.0.0`.
80+
81+
### Full Exampple
82+
83+
```yaml
84+
- uses: psycho0verload/increment-version@latest
85+
with:
86+
current-version: 'v1.0.0-rc.5+123'
87+
version-type: 'major'
88+
preversion: false
89+
preversion-start-zero: true
90+
use-build: true
91+
prefix: false
92+
```
93+
The expected result is: `1.0.1-alpha+124`.
94+
95+
## Expected behavior
96+
To provide an insight into the behavior and a view of the expected results, here are a few cases with their results:
97+
- [Increase `1.0.0` through `patch` and all possible combinations of options](docu/expected_behavior_1.0.0_patch.md)
98+
- [Increase `v1.0.0` through `patch` and all possible combinations of options](docu/expected_behavior_v1.0.0_patch.md)
99+
- [Increase `v1.0.0+123` through `patch-alpha` and all possible combinations of options](docu/expected_behavior_v1.0.0+123_patch-alpha.md)
100+
- [Increase `v1.0.0-rc.5+123` through `patch-alpha` and all possible combinations of options](docu/expected_behavior_v1.0.0-rc.5+123_patch-alpha.md)
101+
- [Increase `v1.0.0-rc.5+123` through `rc` and all possible combinations of options](docu/expected_behavior_v1.0.0-rc.5+123_rc.md)

‎docu/expected_behavior_1.0.0_patch.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# 🧪 Expected behavior
2+
3+
| current-version | version-type | preversion | preversion-start-zero | use-build | prefix | Result | Status |
4+
|-----------------|--------------|------------|------------------------|-----------|--------|--------|--------|
5+
| `1.0.0` | `patch` | `false` | `false` | `false` | `false` | `1.0.1` | ✅ |
6+
| `1.0.0` | `patch` | `false` | `false` | `false` | `true` | `v1.0.1` | ✅ |
7+
| `1.0.0` | `patch` | `false` | `false` | `true` | `false` | `1.0.1+1` | ✅ |
8+
| `1.0.0` | `patch` | `false` | `false` | `true` | `true` | `v1.0.1+1` | ✅ |
9+
| `1.0.0` | `patch` | `false` | `true` | `false` | `false` | `1.0.1` | ✅ |
10+
| `1.0.0` | `patch` | `false` | `true` | `false` | `true` | `v1.0.1` | ✅ |
11+
| `1.0.0` | `patch` | `false` | `true` | `true` | `false` | `1.0.1+1` | ✅ |
12+
| `1.0.0` | `patch` | `false` | `true` | `true` | `true` | `v1.0.1+1` | ✅ |
13+
| `1.0.0` | `patch` | `true` | `false` | `false` | `false` | `1.0.1` | ✅ |
14+
| `1.0.0` | `patch` | `true` | `false` | `false` | `true` | `v1.0.1` | ✅ |
15+
| `1.0.0` | `patch` | `true` | `false` | `true` | `false` | `1.0.1+1` | ✅ |
16+
| `1.0.0` | `patch` | `true` | `false` | `true` | `true` | `v1.0.1+1` | ✅ |
17+
| `1.0.0` | `patch` | `true` | `true` | `false` | `false` | `1.0.1` | ✅ |
18+
| `1.0.0` | `patch` | `true` | `true` | `false` | `true` | `v1.0.1` | ✅ |
19+
| `1.0.0` | `patch` | `true` | `true` | `true` | `false` | `1.0.1+1` | ✅ |
20+
| `1.0.0` | `patch` | `true` | `true` | `true` | `true` | `v1.0.1+1` | ✅ |
21+
22+
[Back to README](../README.md)

‎docu/expected_behavior_v1.0.0+123_patch-alpha.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# 🧪 Expected behavior
2+
3+
| current-version | version-type | preversion | preversion-start-zero | use-build | prefix | Result | Status |
4+
|-----------------|--------------|------------|------------------------|-----------|--------|--------|--------|
5+
| `v1.0.0+123` | `patch-alpha` | `false` | `false` | `false` | `false` | `1.0.1-alpha` | ✅ |
6+
| `v1.0.0+123` | `patch-alpha` | `false` | `false` | `false` | `true` | `v1.0.1-alpha` | ✅ |
7+
| `v1.0.0+123` | `patch-alpha` | `false` | `false` | `true` | `false` | `1.0.1-alpha+124` | ✅ |
8+
| `v1.0.0+123` | `patch-alpha` | `false` | `false` | `true` | `true` | `v1.0.1-alpha+124` | ✅ |
9+
| `v1.0.0+123` | `patch-alpha` | `false` | `true` | `false` | `false` | `1.0.1-alpha` | ✅ |
10+
| `v1.0.0+123` | `patch-alpha` | `false` | `true` | `false` | `true` | `v1.0.1-alpha` | ✅ |
11+
| `v1.0.0+123` | `patch-alpha` | `false` | `true` | `true` | `false` | `1.0.1-alpha+124` | ✅ |
12+
| `v1.0.0+123` | `patch-alpha` | `false` | `true` | `true` | `true` | `v1.0.1-alpha+124` | ✅ |
13+
| `v1.0.0+123` | `patch-alpha` | `true` | `false` | `false` | `false` | `1.0.1-alpha.1` | ✅ |
14+
| `v1.0.0+123` | `patch-alpha` | `true` | `false` | `false` | `true` | `v1.0.1-alpha.1` | ✅ |
15+
| `v1.0.0+123` | `patch-alpha` | `true` | `false` | `true` | `false` | `1.0.1-alpha.1+124` | ✅ |
16+
| `v1.0.0+123` | `patch-alpha` | `true` | `false` | `true` | `true` | `v1.0.1-alpha.1+124` | ✅ |
17+
| `v1.0.0+123` | `patch-alpha` | `true` | `true` | `false` | `false` | `1.0.1-alpha.0` | ✅ |
18+
| `v1.0.0+123` | `patch-alpha` | `true` | `true` | `false` | `true` | `v1.0.1-alpha.0` | ✅ |
19+
| `v1.0.0+123` | `patch-alpha` | `true` | `true` | `true` | `false` | `1.0.1-alpha.0+124` | ✅ |
20+
| `v1.0.0+123` | `patch-alpha` | `true` | `true` | `true` | `true` | `v1.0.1-alpha.0+124` | ✅ |
21+
22+
[Back to README](../README.md)

‎docu/expected_behavior_v1.0.0-rc.5+123_patch-alpha.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# 🧪 Expected behavior
2+
3+
| current-version | version-type | preversion | preversion-start-zero | use-build | prefix | Result | Status |
4+
|-----------------|--------------|------------|------------------------|-----------|--------|--------|--------|
5+
| `v1.0.0-rc.5+123` | `patch-alpha` | `false` | `false` | `false` | `false` | `1.0.1-alpha` | ✅ |
6+
| `v1.0.0-rc.5+123` | `patch-alpha` | `false` | `false` | `false` | `true` | `v1.0.1-alpha` | ✅ |
7+
| `v1.0.0-rc.5+123` | `patch-alpha` | `false` | `false` | `true` | `false` | `1.0.1-alpha+124` | ✅ |
8+
| `v1.0.0-rc.5+123` | `patch-alpha` | `false` | `false` | `true` | `true` | `v1.0.1-alpha+124` | ✅ |
9+
| `v1.0.0-rc.5+123` | `patch-alpha` | `false` | `true` | `false` | `false` | `1.0.1-alpha` | ✅ |
10+
| `v1.0.0-rc.5+123` | `patch-alpha` | `false` | `true` | `false` | `true` | `v1.0.1-alpha` | ✅ |
11+
| `v1.0.0-rc.5+123` | `patch-alpha` | `false` | `true` | `true` | `false` | `1.0.1-alpha+124` | ✅ |
12+
| `v1.0.0-rc.5+123` | `patch-alpha` | `false` | `true` | `true` | `true` | `v1.0.1-alpha+124` | ✅ |
13+
| `v1.0.0-rc.5+123` | `patch-alpha` | `true` | `false` | `false` | `false` | `1.0.1-alpha.1` | ✅ |
14+
| `v1.0.0-rc.5+123` | `patch-alpha` | `true` | `false` | `false` | `true` | `v1.0.1-alpha.1` | ✅ |
15+
| `v1.0.0-rc.5+123` | `patch-alpha` | `true` | `false` | `true` | `false` | `1.0.1-alpha.1+124` | ✅ |
16+
| `v1.0.0-rc.5+123` | `patch-alpha` | `true` | `false` | `true` | `true` | `v1.0.1-alpha.1+124` | ✅ |
17+
| `v1.0.0-rc.5+123` | `patch-alpha` | `true` | `true` | `false` | `false` | `1.0.1-alpha.0` | ✅ |
18+
| `v1.0.0-rc.5+123` | `patch-alpha` | `true` | `true` | `false` | `true` | `v1.0.1-alpha.0` | ✅ |
19+
| `v1.0.0-rc.5+123` | `patch-alpha` | `true` | `true` | `true` | `false` | `1.0.1-alpha.0+124` | ✅ |
20+
| `v1.0.0-rc.5+123` | `patch-alpha` | `true` | `true` | `true` | `true` | `v1.0.1-alpha.0+124` | ✅ |
21+
22+
[Back to README](../README.md)

‎docu/expected_behavior_v1.0.0-rc.5+123_rc.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# 🧪 Expected behavior
2+
3+
| current-version | version-type | preversion | preversion-start-zero | use-build | prefix | Result | Status |
4+
|-----------------|--------------|------------|------------------------|-----------|--------|--------|--------|
5+
| `v1.0.0-rc.5+123` | `rc` | `false` | `false` | `false` | `false` | `1.0.0-rc.6` | ✅ |
6+
| `v1.0.0-rc.5+123` | `rc` | `false` | `false` | `false` | `true` | `v1.0.0-rc.6` | ✅ |
7+
| `v1.0.0-rc.5+123` | `rc` | `false` | `false` | `true` | `false` | `1.0.0-rc.6+124` | ✅ |
8+
| `v1.0.0-rc.5+123` | `rc` | `false` | `false` | `true` | `true` | `v1.0.0-rc.6+124` | ✅ |
9+
| `v1.0.0-rc.5+123` | `rc` | `false` | `true` | `false` | `false` | `1.0.0-rc.6` | ✅ |
10+
| `v1.0.0-rc.5+123` | `rc` | `false` | `true` | `false` | `true` | `v1.0.0-rc.6` | ✅ |
11+
| `v1.0.0-rc.5+123` | `rc` | `false` | `true` | `true` | `false` | `1.0.0-rc.6+124` | ✅ |
12+
| `v1.0.0-rc.5+123` | `rc` | `false` | `true` | `true` | `true` | `v1.0.0-rc.6+124` | ✅ |
13+
| `v1.0.0-rc.5+123` | `rc` | `true` | `false` | `false` | `false` | `1.0.0-rc.6` | ✅ |
14+
| `v1.0.0-rc.5+123` | `rc` | `true` | `false` | `false` | `true` | `v1.0.0-rc.6` | ✅ |
15+
| `v1.0.0-rc.5+123` | `rc` | `true` | `false` | `true` | `false` | `1.0.0-rc.6+124` | ✅ |
16+
| `v1.0.0-rc.5+123` | `rc` | `true` | `false` | `true` | `true` | `v1.0.0-rc.6+124` | ✅ |
17+
| `v1.0.0-rc.5+123` | `rc` | `true` | `true` | `false` | `false` | `1.0.0-rc.6` | ✅ |
18+
| `v1.0.0-rc.5+123` | `rc` | `true` | `true` | `false` | `true` | `v1.0.0-rc.6` | ✅ |
19+
| `v1.0.0-rc.5+123` | `rc` | `true` | `true` | `true` | `false` | `1.0.0-rc.6+124` | ✅ |
20+
| `v1.0.0-rc.5+123` | `rc` | `true` | `true` | `true` | `true` | `v1.0.0-rc.6+124` | ✅ |
21+
22+
[Back to README](../README.md)

‎docu/expected_behavior_v1.0.0_patch.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# 🧪 Expected behavior
2+
3+
| current-version | version-type | preversion | preversion-start-zero | use-build | prefix | Result | Status |
4+
|-----------------|--------------|------------|------------------------|-----------|--------|--------|--------|
5+
| `v1.0.0` | `patch` | `false` | `false` | `false` | `false` | `1.0.1` | ✅ |
6+
| `v1.0.0` | `patch` | `false` | `false` | `false` | `true` | `v1.0.1` | ✅ |
7+
| `v1.0.0` | `patch` | `false` | `false` | `true` | `false` | `1.0.1+1` | ✅ |
8+
| `v1.0.0` | `patch` | `false` | `false` | `true` | `true` | `v1.0.1+1` | ✅ |
9+
| `v1.0.0` | `patch` | `false` | `true` | `false` | `false` | `1.0.1` | ✅ |
10+
| `v1.0.0` | `patch` | `false` | `true` | `false` | `true` | `v1.0.1` | ✅ |
11+
| `v1.0.0` | `patch` | `false` | `true` | `true` | `false` | `1.0.1+1` | ✅ |
12+
| `v1.0.0` | `patch` | `false` | `true` | `true` | `true` | `v1.0.1+1` | ✅ |
13+
| `v1.0.0` | `patch` | `true` | `false` | `false` | `false` | `1.0.1` | ✅ |
14+
| `v1.0.0` | `patch` | `true` | `false` | `false` | `true` | `v1.0.1` | ✅ |
15+
| `v1.0.0` | `patch` | `true` | `false` | `true` | `false` | `1.0.1+1` | ✅ |
16+
| `v1.0.0` | `patch` | `true` | `false` | `true` | `true` | `v1.0.1+1` | ✅ |
17+
| `v1.0.0` | `patch` | `true` | `true` | `false` | `false` | `1.0.1` | ✅ |
18+
| `v1.0.0` | `patch` | `true` | `true` | `false` | `true` | `v1.0.1` | ✅ |
19+
| `v1.0.0` | `patch` | `true` | `true` | `true` | `false` | `1.0.1+1` | ✅ |
20+
| `v1.0.0` | `patch` | `true` | `true` | `true` | `true` | `v1.0.1+1` | ✅ |
21+
22+
[Back to README](../README.md)

0 commit comments

Comments
 (0)