✨ Add github-token input to composite actions

Author: bitwizeshift

issues/add-assignees/action.yaml

@@ -14,19 +14,31 @@ inputs:
   owner:
     required: false
     default: ""
-    description: "The repository owner"
+    description: |
+      The repository owner.
+      If unspecified, this will default to the owner of the current repository.
   repo:
     required: false
     default: ""
-    description: "The repository"
+    description: |
+      The name of the repository.
+      If unspecified, this will default to the current repository.
+  github-token:
+    required: false
+    default: "${{ github.token }}"
+    description: |
+      The default token to use for this Git operation.
+      If unspecified, this will default to `github.token`.
   retries:
     required: false
     default: "0"
-    description: "The number of times to try retrying"
+    description: |
+      The number of times to attempt to retry if this fails.
   retry-exempt-status-codes:
     required: false
     default: "400,401,403,404,422"
-    description: "The retry exempt status codes"
+    description: |
+      A list of error-codes that are exempt from being retried.
 
 runs:
   using: "composite"
@@ -36,6 +48,7 @@ runs:
       with:
         retries: ${{ inputs.retries }}
         retry-exempt-status-codes: ${{ inputs.retry-exempt-status-codes }}
+        github-token: ${{ inputs.github-token }}
         script: |
           github.rest.issues.addAssignees({
             owner: `${{ inputs.owner }}` || context.repo.owner,

issues/add-labels/action.yaml

@@ -14,19 +14,31 @@ inputs:
   owner:
     required: false
     default: ""
-    description: "The repository owner"
+    description: |
+      The repository owner.
+      If unspecified, this will default to the owner of the current repository.
   repo:
     required: false
     default: ""
-    description: "The repository"
+    description: |
+      The name of the repository.
+      If unspecified, this will default to the current repository.
+  github-token:
+    required: false
+    default: "${{ github.token }}"
+    description: |
+      The default token to use for this Git operation.
+      If unspecified, this will default to `github.token`.
   retries:
     required: false
     default: "0"
-    description: "The number of times to try retrying"
+    description: |
+      The number of times to attempt to retry if this fails.
   retry-exempt-status-codes:
     required: false
     default: "400,401,403,404,422"
-    description: "The retry exempt status codes"
+    description: |
+      A list of error-codes that are exempt from being retried.
 
 runs:
   using: "composite"
@@ -36,6 +48,7 @@ runs:
       with:
         retries: ${{ inputs.retries }}
         retry-exempt-status-codes: ${{ inputs.retry-exempt-status-codes }}
+        github-token: ${{ inputs.github-token }}
         script: |
           github.rest.issues.addLabels({
             owner: `${{ inputs.owner }}` || context.repo.owner,

issues/close/action.yaml

@@ -15,19 +15,31 @@ inputs:
   owner:
     required: false
     default: ""
-    description: "The repository owner"
+    description: |
+      The repository owner.
+      If unspecified, this will default to the owner of the current repository.
   repo:
     required: false
     default: ""
-    description: "The repository"
+    description: |
+      The name of the repository.
+      If unspecified, this will default to the current repository.
+  github-token:
+    required: false
+    default: "${{ github.token }}"
+    description: |
+      The default token to use for this Git operation.
+      If unspecified, this will default to `github.token`.
   retries:
     required: false
     default: "0"
-    description: "The number of times to try retrying"
+    description: |
+      The number of times to attempt to retry if this fails.
   retry-exempt-status-codes:
     required: false
     default: "400,401,403,404,422"
-    description: "The retry exempt status codes"
+    description: |
+      A list of error-codes that are exempt from being retried.
 
 runs:
   using: "composite"
@@ -37,6 +49,7 @@ runs:
       with:
         retries: ${{ inputs.retries }}
         retry-exempt-status-codes: ${{ inputs.retry-exempt-status-codes }}
+        github-token: ${{ inputs.github-token }}
         script: |
           github.rest.issues.update({
             owner: `${{ inputs.owner }}` || context.repo.owner,

issues/create-comment/action.yaml

@@ -14,19 +14,31 @@ inputs:
   owner:
     required: false
     default: ""
-    description: "The repository owner"
+    description: |
+      The repository owner.
+      If unspecified, this will default to the owner of the current repository.
   repo:
     required: false
     default: ""
-    description: "The repository"
+    description: |
+      The name of the repository.
+      If unspecified, this will default to the current repository.
+  github-token:
+    required: false
+    default: "${{ github.token }}"
+    description: |
+      The default token to use for this Git operation.
+      If unspecified, this will default to `github.token`.
   retries:
     required: false
     default: "0"
-    description: "The number of times to try retrying"
+    description: |
+      The number of times to attempt to retry if this fails.
   retry-exempt-status-codes:
     required: false
     default: "400,401,403,404,422"
-    description: "The retry exempt status codes"
+    description: |
+      A list of error-codes that are exempt from being retried.
 outputs:
   comment-id:
     value: ${{ steps.create-comment.outputs.comment-id }}
@@ -47,6 +59,7 @@ runs:
       with:
         retries: ${{ inputs.retries }}
         retry-exempt-status-codes: ${{ inputs.retry-exempt-status-codes }}
+        github-token: ${{ inputs.github-token }}
         script: |
           const { data: comment } = await github.rest.issues.createComment({
             issue_number: ${{ inputs.issue-number }} || context.issue.number,

issues/create-or-comment/action.yaml

@@ -27,19 +27,32 @@ inputs:
   owner:
     required: false
     default: ""
-    description: "The repository owner"
+    description: |
+      The repository owner.
+      If unspecified, this will default to the owner of the current repository.
   repo:
     required: false
     default: ""
-    description: "The repository"
+    description: |
+      The name of the repository.
+      If unspecified, this will default to the current repository.
+  github-token:
+    required: false
+    default: "${{ github.token }}"
+    description: |
+      The default token to use for this Git operation.
+      If unspecified, this will default to `github.token`.
   retries:
     required: false
-    default: "3"
-    description: "The number of times to try retrying"
+    default: "0"
+    description: |
+      The number of times to attempt to retry if this fails.
   retry-exempt-status-codes:
     required: false
     default: "400,401,403,404,422"
-    description: "The retry exempt status codes"
+    description: |
+      A list of error-codes that are exempt from being retried.
+
 outputs:
   issue-number:
     value: ${{ steps.create-or-comment.outputs.issue-number }}
@@ -60,6 +73,7 @@ runs:
       with:
         retries: ${{ inputs.retries }}
         retry-exempt-status-codes: ${{ inputs.retry-exempt-status-codes }}
+        github-token: ${{ inputs.github-token }}
         script: |
           const issues = await github.paginate(github.rest.issues.listForRepo, {
             owner: `${{ inputs.owner }}` || context.repo.owner,

issues/create/action.yaml

@@ -22,19 +22,31 @@ inputs:
   owner:
     required: false
     default: ""
-    description: "The repository owner"
+    description: |
+      The repository owner.
+      If unspecified, this will default to the owner of the current repository.
   repo:
     required: false
     default: ""
-    description: "The repository"
+    description: |
+      The name of the repository.
+      If unspecified, this will default to the current repository.
+  github-token:
+    required: false
+    default: "${{ github.token }}"
+    description: |
+      The default token to use for this Git operation.
+      If unspecified, this will default to `github.token`.
   retries:
     required: false
-    default: "3"
-    description: "The number of times to try retrying"
+    default: "0"
+    description: |
+      The number of times to attempt to retry if this fails.
   retry-exempt-status-codes:
     required: false
     default: "400,401,403,404,422"
-    description: "The retry exempt status codes"
+    description: |
+      A list of error-codes that are exempt from being retried.
 outputs:
   issue-number:
     value: ${{ steps.create.outputs.issue-number }}
@@ -52,6 +64,7 @@ runs:
       with:
         retries: ${{ inputs.retries }}
         retry-exempt-status-codes: ${{ inputs.retry-exempt-status-codes }}
+        github-token: ${{ inputs.github-token }}
         script: |
           const { data: issue } = await github.rest.issues.create({
             owner: `${{ inputs.owner }}` || context.repo.owner,

issues/delete-comment/action.yaml

@@ -10,19 +10,31 @@ inputs:
   owner:
     required: false
     default: ""
-    description: "The repository owner"
+    description: |
+      The repository owner.
+      If unspecified, this will default to the owner of the current repository.
   repo:
     required: false
     default: ""
-    description: "The repository"
+    description: |
+      The name of the repository.
+      If unspecified, this will default to the current repository.
+  github-token:
+    required: false
+    default: "${{ github.token }}"
+    description: |
+      The default token to use for this Git operation.
+      If unspecified, this will default to `github.token`.
   retries:
     required: false
     default: "0"
-    description: "The number of times to try retrying"
+    description: |
+      The number of times to attempt to retry if this fails.
   retry-exempt-status-codes:
     required: false
     default: "400,401,403,404,422"
-    description: "The retry exempt status codes"
+    description: |
+      A list of error-codes that are exempt from being retried.
 
 runs:
   using: "composite"
@@ -33,6 +45,7 @@ runs:
       with:
         retries: ${{ inputs.retries }}
         retry-exempt-status-codes: ${{ inputs.retry-exempt-status-codes }}
+        github-token: ${{ inputs.github-token }}
         script: |
           github.rest.issues.deleteComment({
             owner: `${{ inputs.owner }}` || context.repo.owner,

issues/get/action.yaml

@@ -11,19 +11,31 @@ inputs:
   owner:
     required: false
     default: ""
-    description: "The repository owner"
+    description: |
+      The repository owner.
+      If unspecified, this will default to the owner of the current repository.
   repo:
     required: false
     default: ""
-    description: "The repository"
+    description: |
+      The name of the repository.
+      If unspecified, this will default to the current repository.
+  github-token:
+    required: false
+    default: "${{ github.token }}"
+    description: |
+      The default token to use for this Git operation.
+      If unspecified, this will default to `github.token`.
   retries:
     required: false
-    default: "3"
-    description: "The number of times to try retrying"
+    default: "0"
+    description: |
+      The number of times to attempt to retry if this fails.
   retry-exempt-status-codes:
     required: false
     default: "400,401,403,404,422"
-    description: "The retry exempt status codes"
+    description: |
+      A list of error-codes that are exempt from being retried.
 outputs:
   issue-number:
     value: ${{ steps.get-issue.outputs.issue-number }}
@@ -71,6 +83,7 @@ runs:
       with:
         retries: ${{ inputs.retries }}
         retry-exempt-status-codes: ${{ inputs.retry-exempt-status-codes }}
+        github-token: ${{ inputs.github-token }}
         script: |
           const { data: issue } = await github.rest.issues.get({
             owner: `${{ inputs.owner }}` || context.repo.owner,