GitTools/actions
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #814 from GitTools/feature/691

Browse Source
This commit is contained in:
Artur
2023-03-11 13:46:49 +01:00
parent b30860fe81
commit cdf70088b7
56 changed files with 725 additions and 402 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/examples/github/gitversion/execute/usage-examples.md
View File

@@ -100,10 +100,10 @@ Calculate the version for the build.
```yaml
steps:
# gitversion/setup@v0.9.7 action omitted for brevity.
# gitversion/setup@v0 action omitted for brevity.
- name: Determine Version
uses: gittools/actions/gitversion/execute@v0.9.7
uses: gittools/actions/gitversion/execute@v0
```
### Example 2
@@ -113,7 +113,7 @@ Calculate the version for the build using a config file with the default name **
```yaml
steps:
- name: Determine Version
uses: gittools/actions/gitversion/execute@v0.9.7
uses: gittools/actions/gitversion/execute@v0
with:
useConfigFile: true
```
@@ -135,10 +135,10 @@ Calculate the version for the build using a config file named **VersionConfig.ym
```yaml
steps:
# gitversion/setup@v0.9.7 action omitted for brevity.
# gitversion/setup@v0 action omitted for brevity.
- name: Determine Version
uses: gittools/actions/gitversion/execute@v0.9.7
uses: gittools/actions/gitversion/execute@v0
with:
useConfigFile: true
configFilePath: VersionConfig.yml
@@ -150,10 +150,10 @@ Show the effective configuration for GitVersion by running the **/showConfig** c
```yaml
steps:
# gitversion/setup@v0.9.7 action omitted for brevity.
# gitversion/setup@v0 action omitted for brevity.
- name: Display GitVersion config
uses: gittools/actions/gitversion/execute@v0.9.7
uses: gittools/actions/gitversion/execute@v0
with:
useConfigFile: true
additionalArguments: '/showConfig'
@@ -165,11 +165,11 @@ Calculate the version for the build and display all the calculated variables in
```yaml
steps:
# gitversion/setup@v0.9.7 action omitted for brevity.
# gitversion/setup@v0 action omitted for brevity.
- name: Determine Version
id: gitversion
uses: gittools/actions/gitversion/execute@v0.9.7
uses: gittools/actions/gitversion/execute@v0
- name: Display GitVersion outputs
run: |
@@ -213,10 +213,10 @@ Calculate the version for the build and display the value of the `GITVERSION_SEM
```yaml
steps:
# gitversion/setup@v0.9.7 action omitted for brevity.
# gitversion/setup@v0 action omitted for brevity.
- name: Determine Version
uses: gittools/actions/gitversion/execute@v0.9.7
uses: gittools/actions/gitversion/execute@v0
- name: Display SemVer
run: |
@@ -239,7 +239,7 @@ jobs:
- name: Determine Version
id: gitversion
uses: gittools/actions/gitversion/execute@v0.9.7
uses: gittools/actions/gitversion/execute@v0
create-release-notes:
name: Create Release Notes
@@ -268,7 +268,7 @@ jobs:
- name: Determine Version
id: gitversion
uses: gittools/actions/gitversion/execute@v0.9.7
uses: gittools/actions/gitversion/execute@v0
display-semver:
name: Display Semantic Version

19
docs/examples/github/gitversion/setup/usage-examples.md
View File

@@ -34,7 +34,7 @@ Install the latest GitVersion 5 version.
```yaml
steps:
- name: Install GitVersion
uses: gittools/actions/gitversion/setup@v0.9.7
uses: gittools/actions/gitversion/setup@v0
with:
versionSpec: '5.x'
```
@@ -46,7 +46,7 @@ Install GitVersion 5.5.0.
```yaml
steps:
- name: Install GitVersion
uses: gittools/actions/gitversion/setup@v0.9.7
uses: gittools/actions/gitversion/setup@v0
with:
versionSpec: '5.5.0'
```
@@ -58,8 +58,21 @@ Install the latest GitVersion 6 pre-release version. For example **6.0.0-beta1.
```yaml
steps:
- name: Install GitVersion
uses: gittools/actions/gitversion/setup@v0.9.7
uses: gittools/actions/gitversion/setup@v0
with:
versionSpec: '6.x'
includePrerelease: true
```
### Example 4
Install the latest GitVersion 5 version even it there is a cached version matching the versionSpec.
```yaml
steps:
- name: Install GitVersion
uses: gittools/actions/gitversion/setup@v0
with:
versionSpec: '5.x'
preferLatestVersion: true
```