fix for being unable to rename github repo

GitHub-Repositories-Repository/docs/README.md

@@ -87,7 +87,7 @@ _Required_: Yes
 
 _Type_: String
 
-_Update requires_: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)
+_Update requires_: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)
 
 #### Description
 
@@ -301,6 +301,10 @@ The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of
 
 For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).
 
+#### Id
+
+The ID of the repository.
+
 #### Owner
 
 ID of the repository owner.

GitHub-Repositories-Repository/github-repositories-repository.json

@@ -100,6 +100,10 @@
     ]
   },
   "properties": {
+    "Id": {
+      "description": "The ID of the repository.",
+      "type": "number"
+    },
     "Organization": {
       "description": "The organization name. The name is not case sensitive. If not specified, then the managed repository will be within the currently logged-in user account.",
       "type": "string"
@@ -245,6 +249,7 @@
     "Name"
   ],
   "readOnlyProperties": [
+    "/properties/Id",
     "/properties/Owner",
     "/properties/HtmlUrl",
     "/properties/GitUrl",
@@ -257,7 +262,6 @@
   ],
   "createOnlyProperties": [
     "/properties/Organization",
-    "/properties/Name",
     "/properties/TeamId",
     "/properties/AutoInit",
     "/properties/GitIgnoreTemplate",
@@ -273,24 +277,34 @@
     "/properties/SecurityAndAnalysis"
   ],
   "primaryIdentifier": [
-    "/properties/Owner",
-    "/properties/Name"
+    "/properties/Id",
+    "/properties/Owner"
   ],
   "handlers": {
     "create": {
-      "permissions": []
+      "permissions": [
+        "appsync:CreateApiKey"
+      ]
     },
     "read": {
-      "permissions": []
+      "permissions": [
+        "appsync:CreateApiKey"
+      ]
     },
     "update": {
-      "permissions": []
+      "permissions": [
+        "appsync:CreateApiKey"
+      ]
     },
     "delete": {
-      "permissions": []
+      "permissions": [
+        "appsync:CreateApiKey"
+      ]
     },
     "list": {
-      "permissions": []
+      "permissions": [
+        "appsync:CreateApiKey"
+      ]
     }
   }
 }

GitHub-Repositories-Repository/resource-role.yaml

@@ -28,9 +28,9 @@ Resources:
           PolicyDocument:
             Version: '2012-10-17'
             Statement:
-              - Effect: Deny
+              - Effect: Allow
                 Action:
-                - "*"
+                - "appsync:CreateApiKey"
                 Resource: "*"
 Outputs:
   ExecutionRoleArn:

GitHub-Repositories-Repository/src/handlers.ts

@@ -67,9 +67,13 @@ class Resource extends AbstractGitHubResource<ResourceModel, GetUserRepoResponse
             userAgent: this.userAgent
         });
 
-        const response = await octokit.request<GetUserRepoEndpoint>('GET /repos/{owner}/{repo}', {
-            owner: model.owner,
-            repo: model.name
+        // Note - in order to allow renaming the github repo, we need to use the id instead of owner and name for the path.
+        // See here for more information about this api (since it's undocumented): https://github.com/piotrmurach/github/issues/282
+        // ts ignore below necessary as this path is not part of octokit endpoints
+
+        // @ts-ignore
+        const response = await octokit.request<GetRepoByIdEndpoint>('GET /repositories/{id}', {
+            id: model.id
         });
 
         return response.data;
@@ -168,9 +172,14 @@ class Resource extends AbstractGitHubResource<ResourceModel, GetUserRepoResponse
             payload.allow_forking = model.allowForking;
         }
 
-        const response = await octokit.request<UpdateRepoEndpoint>(
-            'PATCH /repos/{owner}/{repo}',
-            payload);
+        const pathWithId = `PATCH /repositories/${model.id}`;
+
+        // Note - in order to allow renaming the github repo, we need to use the id instead of owner and name for the path.
+        // See here for more information about this api (since it's undocumented): https://github.com/piotrmurach/github/issues/282
+        // ts ignore below necessary as this path is not part of octokit endpoints
+
+        // @ts-ignore
+        const response = await octokit.request<UpdateRepoEndpoint>(pathWithId, payload);
 
         return response.data;
     }
@@ -181,9 +190,8 @@ class Resource extends AbstractGitHubResource<ResourceModel, GetUserRepoResponse
             userAgent: this.userAgent
         });
 
-        await octokit.request('DELETE /repos/{owner}/{repo}', {
-            owner: model.owner,
-            repo: model.name
+        await octokit.request('DELETE /repositories/{repositoryId}', {
+            repositoryId: model.id,
         });
     }
 
@@ -199,6 +207,7 @@ class Resource extends AbstractGitHubResource<ResourceModel, GetUserRepoResponse
         delete from.updated_at;
 
         let resourceModel: ResourceModel = new ResourceModel( {
+            id: from.id,
             owner: from.owner?.login ? from.owner.login : model.owner,
             licenseTemplate: from.license?.key,
             name: from.name,

GitHub-Repositories-Repository/src/models.ts

@@ -9,10 +9,19 @@ export class ResourceModel extends BaseModel {
     public static readonly TYPE_NAME: string = 'GitHub::Repositories::Repository';
 
     @Exclude()
-    protected readonly IDENTIFIER_KEY_OWNER: string = '/properties/Owner';
+    protected readonly IDENTIFIER_KEY_ID: string = '/properties/Id';
     @Exclude()
-    protected readonly IDENTIFIER_KEY_NAME: string = '/properties/Name';
+    protected readonly IDENTIFIER_KEY_OWNER: string = '/properties/Owner';
 
+    @Expose({ name: 'Id' })
+    @Transform(
+        (value: any, obj: any) =>
+            transformValue(Number, 'id', value, obj, []),
+        {
+            toClassOnly: true,
+        }
+    )
+    id?: Optional<number>;
     @Expose({ name: 'Organization' })
     @Transform(
         (value: any, obj: any) =>
@@ -290,12 +299,12 @@ export class ResourceModel extends BaseModel {
     @Exclude()
     public getPrimaryIdentifier(): Dict {
         const identifier: Dict = {};
-        if (this.owner != null) {
-            identifier[this.IDENTIFIER_KEY_OWNER] = this.owner;
+        if (this.id != null) {
+            identifier[this.IDENTIFIER_KEY_ID] = this.id;
         }
 
-        if (this.name != null) {
-            identifier[this.IDENTIFIER_KEY_NAME] = this.name;
+        if (this.owner != null) {
+            identifier[this.IDENTIFIER_KEY_OWNER] = this.owner;
         }
 
         // only return the identifier if it can be used, i.e. if all components are present