Simplify repository input format in GitReleaseManager

Updated the repository input to require a single string in the format 'owner/repo' for various action configurations and examples. Removed the separate 'owner' input parameter and adjusted relevant test cases and function implementations accordingly to parse repository information from the provided format.
arturcic · Dec 10, 2024 · fc6efe4 · fc6efe4
1 parent bc8cf5c
commit fc6efe4
Show file tree

Hide file tree

Showing 24 changed files with 31 additions and 79 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -40,8 +40,7 @@ jobs:
         uses: ./gitreleasemanager/create
         with:
           token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
-          owner: ${{ github.repository_owner }}
-          repository: actions
+          repository: ${{ github.repository }}
           milestone: "v${{ steps.gitversion.outputs.majorMinorPatch }}"
           name: "v${{ steps.gitversion.outputs.majorMinorPatch }}"
           isPreRelease: 'false'
@@ -67,16 +66,14 @@ jobs:
         uses: ./gitreleasemanager/addasset
         with:
           token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
-          owner: ${{ github.repository_owner }}
-          repository: actions
+          repository: ${{ github.repository }}
           milestone: "v${{ steps.gitversion.outputs.majorMinorPatch }}"
           assets: ${{ steps.publish-azure.outputs.vsix }}
       - name: Close Release
         uses: ./gitreleasemanager/close
         with:
           token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
-          owner: ${{ github.repository_owner }}
-          repository: actions
+          repository: ${{ github.repository }}
           milestone: "v${{ steps.gitversion.outputs.majorMinorPatch }}"
       - name: Get tags
         id: get-tags

diff --git a/docs/examples/azure/gitreleasemanager/addasset.md b/docs/examples/azure/gitreleasemanager/addasset.md
@@ -5,8 +5,7 @@
   - task: gitreleasemanager/addasset@3.1.1
     inputs:
       token: '$(GITHUB_TOKEN)'
-      owner: 'someOwner'
-      repository: 'someRepo'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
       assets: |
         src/test.txt

diff --git a/docs/examples/azure/gitreleasemanager/close.md b/docs/examples/azure/gitreleasemanager/close.md
@@ -5,7 +5,6 @@
   - task: gitreleasemanager/close@3.1.1
     inputs:
       token: '$(GITHUB_TOKEN)'
-      owner: 'someOwner'
-      repository: 'someRepo'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
 ```
diff --git a/docs/examples/azure/gitreleasemanager/create.md b/docs/examples/azure/gitreleasemanager/create.md
@@ -6,8 +6,7 @@
     displayName: Create release with GitReleaseManager
     inputs:
       token: $(GITHUB_TOKEN)
-      owner: 'someOwner'
-      repository: 'someRepo'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
       name: 'v0.1.0'
       assets: |

diff --git a/docs/examples/azure/gitreleasemanager/discard.md b/docs/examples/azure/gitreleasemanager/discard.md
@@ -5,7 +5,6 @@
   - task: gitreleasemanager/discard@3.1.1
     inputs:
       token: '$(GITHUB_TOKEN)'
-      owner: 'someOwner'
-      repository: 'someRepo'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
 ```
diff --git a/docs/examples/azure/gitreleasemanager/open.md b/docs/examples/azure/gitreleasemanager/open.md
@@ -5,7 +5,6 @@
   - task: gitreleasemanager/open@3.1.1
     inputs:
       token: '$(GITHUB_TOKEN)'
-      owner: 'someOwner'
-      repository: 'someRepo'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
 ```
diff --git a/docs/examples/azure/gitreleasemanager/publish.md b/docs/examples/azure/gitreleasemanager/publish.md
@@ -5,7 +5,6 @@
   - task: gitreleasemanager/publish@3.1.1
     inputs:
       token: '$(GITHUB_TOKEN)'
-      owner: 'someOwner'
-      repository: 'someRepo'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
 ```
diff --git a/docs/examples/github/gitreleasemanager/addasset.md b/docs/examples/github/gitreleasemanager/addasset.md
@@ -6,8 +6,7 @@
     name: Add asset to a release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}
-      owner: 'someOwner'
-      repository: 'someRepository'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
       assets: |
         src/test.txt

diff --git a/docs/examples/github/gitreleasemanager/close.md b/docs/examples/github/gitreleasemanager/close.md
@@ -6,7 +6,6 @@
     name: Close release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}
-      owner: 'someOwner'
-      repository: 'someRepository'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
 ```
diff --git a/docs/examples/github/gitreleasemanager/create.md b/docs/examples/github/gitreleasemanager/create.md
@@ -6,8 +6,7 @@
     name: Create release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}
-      owner: 'someOwner'
-      repository: 'someRepository'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
       name: 'v0.1.0'
       assets:  |

diff --git a/docs/examples/github/gitreleasemanager/discard.md b/docs/examples/github/gitreleasemanager/discard.md
@@ -6,7 +6,6 @@
     name: Discard release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}
-      owner: 'someOwner'
-      repository: 'someRepository'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
 ```
diff --git a/docs/examples/github/gitreleasemanager/open.md b/docs/examples/github/gitreleasemanager/open.md
@@ -6,7 +6,6 @@
     name: Open release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}
-      owner: 'someOwner'
-      repository: 'someRepository'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
 ```
diff --git a/docs/examples/github/gitreleasemanager/publish.md b/docs/examples/github/gitreleasemanager/publish.md
@@ -6,7 +6,6 @@
     name: Publish release with GitReleaseManager
     with:
       token: ${{ secrets.GITHUB_TOKEN }}
-      owner: 'someOwner'
-      repository: 'someRepository'
+      repository: 'someOwner/someRepo'
       milestone: '0.1.0'
 ```
diff --git a/gitreleasemanager/addasset/action.yml b/gitreleasemanager/addasset/action.yml
@@ -8,12 +8,8 @@ runs:
   using: node20
   main: main.mjs
 inputs:
-  owner:
-    description: The owner of the repository
-    required: true
-    default: ''
   repository:
-    description: The name of the repository
+    description: The name of the repository in the format owner/repo
     required: true
     default: ''
   token:

diff --git a/gitreleasemanager/close/action.yml b/gitreleasemanager/close/action.yml
@@ -8,12 +8,8 @@ runs:
   using: node20
   main: main.mjs
 inputs:
-  owner:
-    description: The owner of the repository
-    required: true
-    default: ''
   repository:
-    description: The name of the repository
+    description: The name of the repository in the format owner/repo
     required: true
     default: ''
   token:

diff --git a/gitreleasemanager/create/action.yml b/gitreleasemanager/create/action.yml
@@ -8,12 +8,8 @@ runs:
   using: node20
   main: main.mjs
 inputs:
-  owner:
-    description: The owner of the repository
-    required: true
-    default: ''
   repository:
-    description: The name of the repository
+    description: The name of the repository in the format owner/repo
     required: true
     default: ''
   token:

diff --git a/gitreleasemanager/discard/action.yml b/gitreleasemanager/discard/action.yml
@@ -8,12 +8,8 @@ runs:
   using: node20
   main: main.mjs
 inputs:
-  owner:
-    description: The owner of the repository
-    required: true
-    default: ''
   repository:
-    description: The name of the repository
+    description: The name of the repository in the format owner/repo
     required: true
     default: ''
   token:

diff --git a/gitreleasemanager/open/action.yml b/gitreleasemanager/open/action.yml
@@ -8,12 +8,8 @@ runs:
   using: node20
   main: main.mjs
 inputs:
-  owner:
-    description: The owner of the repository
-    required: true
-    default: ''
   repository:
-    description: The name of the repository
+    description: The name of the repository in the format owner/repo
     required: true
     default: ''
   token:

diff --git a/gitreleasemanager/publish/action.yml b/gitreleasemanager/publish/action.yml
@@ -8,12 +8,8 @@ runs:
   using: node20
   main: main.mjs
 inputs:
-  owner:
-    description: The owner of the repository
-    required: true
-    default: ''
   repository:
-    description: The name of the repository
+    description: The name of the repository in the format owner/repo
     required: true
     default: ''
   token:

diff --git a/src/__tests__/tools/gitreleasemanager/settings.spec.ts b/src/__tests__/tools/gitreleasemanager/settings.spec.ts
@@ -14,8 +14,7 @@ import { expectValidSettings } from '../common/utils'
 describe('GitReleaseManager settings', () => {
     it('should return GitReleaseManagerCreateSettings', () => {
         const settings: CreateSettings = {
-            repository: 'repo',
-            owner: 'owner',
+            repository: 'owner/repo',
             token: 'token',
             targetDirectory: 'path',
             milestone: 'milestone',
@@ -42,8 +41,7 @@ describe('GitReleaseManager settings', () => {
 
     it('should return OpenSettings', () => {
         const settings: OpenSettings = {
-            repository: 'repo',
-            owner: 'owner',
+            repository: 'owner/repo',
             token: 'token',
             targetDirectory: 'path',
             milestone: 'milestone',
@@ -63,8 +61,7 @@ describe('GitReleaseManager settings', () => {
 
     it('should return GitReleaseManagerCloseSettings', () => {
         const settings: CloseSettings = {
-            repository: 'repo',
-            owner: 'owner',
+            repository: 'owner/repo',
             token: 'token',
             targetDirectory: 'path',
             milestone: 'milestone',
@@ -84,8 +81,7 @@ describe('GitReleaseManager settings', () => {
 
     it('should return DiscardSettings', () => {
         const settings: DiscardSettings = {
-            repository: 'repo',
-            owner: 'owner',
+            repository: 'owner/repo',
             token: 'token',
             targetDirectory: 'path',
             milestone: 'milestone',
@@ -105,8 +101,7 @@ describe('GitReleaseManager settings', () => {
 
     it('should return PublishSettings', () => {
         const settings: PublishSettings = {
-            repository: 'repo',
-            owner: 'owner',
+            repository: 'owner/repo',
             token: 'token',
             targetDirectory: 'path',
             milestone: 'milestone',
@@ -126,8 +121,7 @@ describe('GitReleaseManager settings', () => {
 
     it('should return AddAssetSettings', () => {
         const settings: AddAssetSettings = {
-            repository: 'repo',
-            owner: 'owner',
+            repository: 'owner/repo',
             token: 'token',
             targetDirectory: 'path',
             milestone: 'milestone',

diff --git a/src/__tests__/tools/gitreleasemanager/tool.spec.ts b/src/__tests__/tools/gitreleasemanager/tool.spec.ts
@@ -133,8 +133,7 @@ describe('GitReleaseManagerTool', () => {
 
     describe('getArguments', () => {
         const commonSettings = {
-            owner: 'owner',
-            repository: 'repo',
+            repository: 'owner/repo',
             token: 'token',
             targetDirectory: 'targetDirectory',
             logFilePath: './logFilePath'

diff --git a/src/tools/gitreleasemanager/models.ts b/src/tools/gitreleasemanager/models.ts
@@ -2,7 +2,6 @@ export type Commands = 'setup' | 'addasset' | 'close' | 'create' | 'discard' | '
 
 export type CommonSettings = {
     repository: string
-    owner: string
     token: string
     targetDirectory: string
     milestone: string

diff --git a/src/tools/gitreleasemanager/settings.ts b/src/tools/gitreleasemanager/settings.ts
@@ -83,14 +83,12 @@ export class GitReleaseManagerSettingsProvider extends SettingsProvider implemen
 
     getCommonSettings(): CommonSettings {
         const milestone = this.buildAgent.getInput<CommonSettings>('milestone')
-        const owner = this.buildAgent.getInput<CommonSettings>('owner')
         const repository = this.buildAgent.getInput<CommonSettings>('repository')
         const token = this.buildAgent.getInput<CommonSettings>('token')
         const targetDirectory = this.buildAgent.getInput<CommonSettings>('targetDirectory')
         const logFilePath = this.buildAgent.getInput<CommonSettings>('logFilePath')
 
         return {
-            owner,
             repository,
             token,
             targetDirectory,

diff --git a/src/tools/gitreleasemanager/tool.ts b/src/tools/gitreleasemanager/tool.ts
@@ -80,8 +80,9 @@ export class GitReleaseManagerTool extends DotnetTool {
     protected async getCommonArguments(settings: CommonSettings): Promise<string[]> {
         const args: string[] = []
 
-        args.push('--owner', settings.owner)
-        args.push('--repository', settings.repository)
+        const [owner, repository] = settings.repository.split('/') // this is the github repository
+        args.push('--owner', owner)
+        args.push('--repository', repository)
         args.push('--token', settings.token)
 
         settings.targetDirectory = await this.getRepoDir(settings)