Merge pull request #1186 from arturcic/main

#1183 - updated examples to use the correct GRM arguments
GitTools · Jul 22, 2024 · 95a86de · 95a86de
2 parents edbb8af + 48a39b9
commit 95a86de
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 16 deletions.
diff --git a/dist/azure/gitreleasemanager/addasset/task.json b/dist/azure/gitreleasemanager/addasset/task.json
@@ -47,12 +47,12 @@
       "helpMarkDown": "The access token to access GitHub with"
     },
     {
-      "name": "tagName",
+      "name": "milestone",
       "type": "string",
-      "label": "The name of the release",
+      "label": "The milestone to use",
       "defaultValue": "",
       "required": true,
-      "helpMarkDown": "The name of the release"
+      "helpMarkDown": "The milestone to use"
     },
     {
       "name": "assets",
@@ -71,4 +71,4 @@
       "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
     }
   ]
-}
+}
diff --git a/dist/azure/gitreleasemanager/publish/task.json b/dist/azure/gitreleasemanager/publish/task.json
@@ -47,12 +47,12 @@
       "helpMarkDown": "The access token to access GitHub with"
     },
     {
-      "name": "tagName",
+      "name": "milestone",
       "type": "string",
-      "label": "The name of the release",
+      "label": "The milestone to use",
       "defaultValue": "",
       "required": true,
-      "helpMarkDown": "The name of the release"
+      "helpMarkDown": "The milestone to use"
     },
     {
       "name": "targetDirectory",
@@ -63,4 +63,4 @@
       "helpMarkDown": "The directory on which GitReleaseManager should be executed. Defaults to current directory"
     }
   ]
-}
+}
diff --git a/docs/examples/azure/gitreleasemanager/addasset.md b/docs/examples/azure/gitreleasemanager/addasset.md
@@ -7,7 +7,7 @@
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'
       repository: 'someRepo'
-      tagName: '0.1.0'
+      milestone: '0.1.0'
       assets: |
         src/test.txt
         src/test1.txt

diff --git a/docs/examples/azure/gitreleasemanager/publish.md b/docs/examples/azure/gitreleasemanager/publish.md
@@ -7,5 +7,5 @@
       token: '$(GITHUB_TOKEN)'
       owner: 'someOwner'
       repository: 'someRepo'
-      tagName: '0.1.0'
+      milestone: '0.1.0'
 ```
diff --git a/docs/examples/github/gitreleasemanager/addasset.md b/docs/examples/github/gitreleasemanager/addasset.md
@@ -8,7 +8,7 @@
       token: ${{ secrets.GITHUB_TOKEN }}
       owner: 'someOwner'
       repository: 'someRepository'
-      tagName: '0.1.0'
+      milestone: '0.1.0'
       assets: |
         src/test.txt
         src/test1.txt

diff --git a/docs/examples/github/gitreleasemanager/publish.md b/docs/examples/github/gitreleasemanager/publish.md
@@ -8,5 +8,5 @@
       token: ${{ secrets.GITHUB_TOKEN }}
       owner: 'someOwner'
       repository: 'someRepository'
-      tagName: '0.1.0'
+      milestone: '0.1.0'
 ```
diff --git a/src/__tests__/tools/gitreleasemanager/tool.spec.ts b/src/__tests__/tools/gitreleasemanager/tool.spec.ts
@@ -293,7 +293,7 @@ describe('GitReleaseManagerTool', () => {
             it('should return correct publish arguments', async () => {
                 const args = await tool.getPublishArguments({
                     ...commonSettings,
-                    milestone: 'tagName'
+                    milestone: 'milestone'
                 } as GitReleaseManagerPublishSettings)
 
                 expect(args).toEqual([
@@ -307,7 +307,7 @@ describe('GitReleaseManagerTool', () => {
                     '--targetDirectory',
                     'targetDirectory',
                     '--tagName',
-                    'tagName'
+                    'milestone'
                 ])
             })
         })
@@ -316,7 +316,7 @@ describe('GitReleaseManagerTool', () => {
             it('should return correct add asset arguments', async () => {
                 const args = await tool.getAddAssetArguments({
                     ...commonSettings,
-                    milestone: 'tagName',
+                    milestone: 'milestone',
                     assets: ['asset1', 'asset2']
                 } as GitReleaseManagerAddAssetSettings)
 
@@ -331,7 +331,7 @@ describe('GitReleaseManagerTool', () => {
                     '--targetDirectory',
                     'targetDirectory',
                     '--tagName',
-                    'tagName',
+                    'milestone',
                     '--assets',
                     `${path.join('targetDirectory', 'asset1')},${path.join('targetDirectory', 'asset2')}`
                 ])