GitTools#1053 - updated docs to use the latest version

arturcic · Mar 11, 2024 · 30f67cf · 30f67cf
1 parent a5ea5ba
commit 30f67cf
Show file tree

Hide file tree

Showing 20 changed files with 93 additions and 66 deletions.
diff --git a/dist/azure/gitreleasemanager/setup/task.json b/dist/azure/gitreleasemanager/setup/task.json
@@ -33,7 +33,7 @@
             "label": "The version spec",
             "defaultValue": "",
             "required": true,
-            "helpMarkDown": "Required version in the form of 0.10.x or exact version like 0.10.2"
+            "helpMarkDown": "Required version in the form of 0.17.x or exact version like 0.17.0"
         },
         {
             "name": "includePrerelease",

diff --git a/docs/examples/azure/gitreleasemanager/addasset.md b/docs/examples/azure/gitreleasemanager/addasset.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - task: gitreleasemanager/addasset@0
+  - task: gitreleasemanager/addasset@0.13.4
     inputs:
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'

diff --git a/docs/examples/azure/gitreleasemanager/close.md b/docs/examples/azure/gitreleasemanager/close.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - task: gitreleasemanager/close@0
+  - task: gitreleasemanager/close@0.13.4
     inputs:
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'

diff --git a/docs/examples/azure/gitreleasemanager/create.md b/docs/examples/azure/gitreleasemanager/create.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - task: gitreleasemanager/create@0
+  - task: gitreleasemanager/create@0.13.4
     displayName: Create release with GitReleaseManager
     inputs:
       token: $(GITHUB_TOKEN)

diff --git a/docs/examples/azure/gitreleasemanager/discard.md b/docs/examples/azure/gitreleasemanager/discard.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - task: gitreleasemanager/discard@0
+  - task: gitreleasemanager/discard@0.13.4
     inputs:
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'

diff --git a/docs/examples/azure/gitreleasemanager/open.md b/docs/examples/azure/gitreleasemanager/open.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - task: gitreleasemanager/open@0
+  - task: gitreleasemanager/open@0.13.4
     inputs:
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'

diff --git a/docs/examples/azure/gitreleasemanager/publish.md b/docs/examples/azure/gitreleasemanager/publish.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - task: gitreleasemanager/publish@0
+  - task: gitreleasemanager/publish@0.13.4
     inputs:
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'

diff --git a/docs/examples/azure/gitreleasemanager/setup.md b/docs/examples/azure/gitreleasemanager/setup.md
@@ -2,8 +2,8 @@
 
 ```yaml
   steps:
-  - task: gitreleasemanager/setup@0
+  - task: gitreleasemanager/setup@0.13.4
     displayName: Install GitReleaseManager
     inputs:
-      versionSpec: '0.10.x'
+      versionSpec: '0.17.x'
 ```
diff --git a/docs/examples/azure/gitversion/execute/usage-examples.md b/docs/examples/azure/gitversion/execute/usage-examples.md
@@ -11,7 +11,7 @@ You must also run the GitVersion Setup step before the Execute step:
 - checkout: self
   fetchDepth: 0
 
-- task: gitversion/setup@0
+- task: gitversion/setup@0.13.4
   displayName: Install GitVersion
   inputs:
     versionSpec: '5.x'
@@ -105,9 +105,9 @@ Calculate the version for the build.
 
 ```yaml
 steps:
-  # gitversion/setup@0 task omitted for brevity.
+  # gitversion/setup@0.13.4 task omitted for brevity.
 
-  - task: gitversion/execute@0
+  - task: gitversion/execute@0.13.4
     displayName: Determine Version
 ```
 
@@ -117,9 +117,9 @@ Calculate the version for the build using a config file with the default name **
 
 ```yaml
 steps:
-  # gitversion/setup@0 task omitted for brevity.
+  # gitversion/setup@0.13.4 task omitted for brevity.
 
-  - task: gitversion/execute@0
+  - task: gitversion/execute@0.13.4
     displayName: Determine Version
     inputs:
       useConfigFile: true
@@ -142,9 +142,9 @@ Calculate the version for the build using a config file named **VersionConfig.ym
 
 ```yaml
 steps:
-  # gitversion/setup@0 task omitted for brevity.
+  # gitversion/setup@0.13.4 task omitted for brevity.
 
-  - task: gitversion/execute@0
+  - task: gitversion/execute@0.13.4
     displayName: Determine Version
     inputs:
       useConfigFile: true
@@ -157,9 +157,9 @@ Show the effective configuration for GitVersion by running the **/showConfig** c
 
 ```yaml
 steps:
-  # gitversion/setup@0 task omitted for brevity.
+  # gitversion/setup@0.13.4 task omitted for brevity.
 
-  - task: gitversion/execute@0
+  - task: gitversion/execute@0.13.4
     displayName: Display GitVersion config
     inputs:
       additionalArguments: '/showConfig'
@@ -171,9 +171,9 @@ Calculate the version for the build and display all the calculated variables in
 
 ```yaml
 steps:
-  # gitversion/setup@0 task omitted for brevity.
+  # gitversion/setup@0.13.4 task omitted for brevity.
 
-  - task: gitversion/execute@0
+  - task: gitversion/execute@0.13.4
     name: version # id to later be referenced
     displayName: Determine Version
 
@@ -254,9 +254,9 @@ Calculate the version for the build and use the `GitVersion.NuGetVersion` variab
 
 ```yaml
 steps:
-  # gitversion/setup@0 task omitted for brevity.
+  # gitversion/setup@0.13.4 task omitted for brevity.
 
-  - task: gitversion/execute@0
+  - task: gitversion/execute@0.13.4
     displayName: Determine Version
 
   - displayName: Display GitVersion variables (without prefix)
@@ -347,9 +347,9 @@ jobs:
   - job: CalculateVersion
     displayName: Calculate version using GitVersion
     steps:
-      # gitversion/setup@0 task omitted for brevity.
+      # gitversion/setup@0.13.4 task omitted for brevity.
 
-      - task: gitversion/execute@0
+      - task: gitversion/execute@0.13.4
         displayName: Use GitVersion
         name: Version # the step MUST be named to access its output variables in another job.
 
@@ -367,9 +367,9 @@ jobs:
   - job: CalculateVersion
     displayName: Calculate version using GitVersion
     steps:
-      # gitversion/setup@0 task omitted for brevity.
+      # gitversion/setup@0.13.4 task omitted for brevity.
 
-      - task: gitversion/execute@0
+      - task: gitversion/execute@0.13.4
         displayName: Use GitVersion
         name: Version # the step MUST be named to access its output variables in another job.
 
@@ -389,9 +389,9 @@ stages:
       - job: CalculateVersion
         displayName: Calculate version number using GitVersion
         steps:
-          # gitversion/setup@0 task omitted for brevity.
+          # gitversion/setup@0.13.4 task omitted for brevity.
 
-          - task: gitversion/execute@0
+          - task: gitversion/execute@0.13.4
             displayName: Use GitVersion
             name: Version # the step MUST be named to access its output variables in another stage.
 
@@ -411,9 +411,9 @@ stages:
       - job: CalculateVersion
         displayName: Calculate version number using GitVersion
         steps:
-          # gitversion/setup@0 task omitted for brevity.
+          # gitversion/setup@0.13.4 task omitted for brevity.
 
-          - task: gitversion/execute@0
+          - task: gitversion/execute@0.13.4
             displayName: Use GitVersion
             name: Version # the step MUST be named to access its output variables in another stage.
   - stage: S2

diff --git a/docs/examples/azure/gitversion/setup/usage-examples.md b/docs/examples/azure/gitversion/setup/usage-examples.md
@@ -45,7 +45,7 @@ Install the latest GitVersion 5 version.
 
 ```yaml
 steps:
-  - task: gitversion/setup@0
+  - task: gitversion/setup@0.13.4
     displayName: Install GitVersion
     inputs:
       versionSpec: '5.x'
@@ -57,7 +57,7 @@ Install GitVersion 5.5.0.
 
 ```yaml
 steps:
-  - task: gitversion/setup@0
+  - task: gitversion/setup@0.13.4
     displayName: Install GitVersion
     inputs:
       versionSpec: '5.5.0'
@@ -69,7 +69,7 @@ Install the latest GitVersion 6 pre-release version.  For example **6.0.0-beta1.
 
 ```yaml
 steps:
-  - task: gitversion/setup@0
+  - task: gitversion/setup@0.13.4
     displayName: Install GitVersion
     inputs:
       versionSpec: '6.x'
@@ -82,7 +82,7 @@ Install the latest GitVersion 5 version even it there is a cached version matchi
 
 ```yaml
 steps:
-  - task: gitversion/setup@0
+  - task: gitversion/setup@0.13.4
     displayName: Install GitVersion
     inputs:
       versionSpec: '5.x'

diff --git a/docs/examples/github/gitreleasemanager/addasset.md b/docs/examples/github/gitreleasemanager/addasset.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/addasset@v0
+  - uses: gittools/actions/gitreleasemanager/addasset@v0.13.4
     name: Add asset to a release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/docs/examples/github/gitreleasemanager/close.md b/docs/examples/github/gitreleasemanager/close.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/close@v0
+  - uses: gittools/actions/gitreleasemanager/close@v0.13.4
     name: Close release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/docs/examples/github/gitreleasemanager/create.md b/docs/examples/github/gitreleasemanager/create.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/create@0
+  - uses: gittools/actions/gitreleasemanager/create@v0.13.4
     name: Create release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/docs/examples/github/gitreleasemanager/discard.md b/docs/examples/github/gitreleasemanager/discard.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/discard@v0
+  - uses: gittools/actions/gitreleasemanager/discard@v0.13.4
     name: Discard release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/docs/examples/github/gitreleasemanager/open.md b/docs/examples/github/gitreleasemanager/open.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/open@v0
+  - uses: gittools/actions/gitreleasemanager/open@v0.13.4
     name: Open release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/docs/examples/github/gitreleasemanager/publish.md b/docs/examples/github/gitreleasemanager/publish.md
@@ -2,7 +2,7 @@
 
 ```yaml
   steps:
-  - uses: gittools/actions/gitreleasemanager/publish@v0
+  - uses: gittools/actions/gitreleasemanager/publish@v0.13.4
     name: Publish release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}

diff --git a/docs/examples/github/gitreleasemanager/setup.md b/docs/examples/github/gitreleasemanager/setup.md
@@ -1,9 +1,36 @@
-# Example
+### Example 1
+
+Install the latest GitReleaseManager version.
+
+```yaml
+steps:
+  - name: Install GitReleaseManager
+    uses: gittools/actions/gitreleasemanager/setup@v0.13.4
+    with:
+      versionSpec: '0.17.x'
+```
+
+### Example 2
+
+Install specific GitReleaseManager version 0.17.0.
+
+```yaml
+steps:
+  - name: Install GitReleaseManager
+    uses: gittools/actions/gitreleasemanager/setup@v0.13.4
+    with:
+      versionSpec: '0.17.0'
+```
+
+### Example 3
+
+Install the latest GitReleaseManager version 0.17.x even it there is a cached version matching the versionSpec.
 
 ```yaml
-  steps:
-  - uses: gittools/actions/gitreleasemanager/setup@v0
-    name: Install GitReleaseManager
+steps:
+  - name: Install GitReleaseManager
+    uses: gittools/actions/gitreleasemanager/setup@v0.13.4
     with:
-      versionSpec: '0.10.x'
+      versionSpec: '0.17.x'
+      preferLatestVersion: true
 ```