feat: lots of new methods and parameters (#484)

octokit · Jun 15, 2022 · 61bbc9a · 61bbc9a
1 parent cd6e9ed
commit 61bbc9a
Show file tree

Hide file tree

Showing 744 changed files with 22,806 additions and 7,036 deletions.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -29,3 +29,5 @@ jobs:
         run: npm ci
       - name: Test
         run: npm test
+      - name: Build to verify integrity of code + types
+        run: npm run build
diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForOrg.md
@@ -0,0 +1,52 @@
+---
+name: Add custom labels to a self-hosted runner for an organization
+example: octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({ org, runner_id, labels })
+route: POST /orgs/{org}/actions/runners/{runner_id}/labels
+scope: actions
+type: API method
+---
+
+# Add custom labels to a self-hosted runner for an organization
+
+Add custom labels to a self-hosted runner configured in an organization.
+
+You must authenticate using an access token with the `admin:org` scope to use this endpoint.
+
+```js
+octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForOrg({
+  org,
+  runner_id,
+  labels,
+});
+```
+
+## Parameters
+
+<table>
+  <thead>
+    <tr>
+      <th>name</th>
+      <th>required</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr><td>org</td><td>yes</td><td>
+
+The organization name. The name is not case sensitive.
+
+</td></tr>
+<tr><td>runner_id</td><td>yes</td><td>
+
+Unique identifier of the self-hosted runner.
+
+</td></tr>
+<tr><td>labels</td><td>yes</td><td>
+
+The names of the custom labels to add to the runner.
+
+</td></tr>
+  </tbody>
+</table>
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-an-organization).
diff --git a/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md b/docs/actions/addCustomLabelsToSelfHostedRunnerForRepo.md
@@ -0,0 +1,59 @@
+---
+name: Add custom labels to a self-hosted runner for a repository
+example: octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({ owner, repo, runner_id, labels })
+route: POST /repos/{owner}/{repo}/actions/runners/{runner_id}/labels
+scope: actions
+type: API method
+---
+
+# Add custom labels to a self-hosted runner for a repository
+
+Add custom labels to a self-hosted runner configured in a repository.
+
+You must authenticate using an access token with the `repo` scope to use this
+endpoint.
+
+```js
+octokit.rest.actions.addCustomLabelsToSelfHostedRunnerForRepo({
+  owner,
+  repo,
+  runner_id,
+  labels,
+});
+```
+
+## Parameters
+
+<table>
+  <thead>
+    <tr>
+      <th>name</th>
+      <th>required</th>
+      <th>description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr><td>owner</td><td>yes</td><td>
+
+The account owner of the repository. The name is not case sensitive.
+
+</td></tr>
+<tr><td>repo</td><td>yes</td><td>
+
+The name of the repository. The name is not case sensitive.
+
+</td></tr>
+<tr><td>runner_id</td><td>yes</td><td>
+
+Unique identifier of the self-hosted runner.
+
+</td></tr>
+<tr><td>labels</td><td>yes</td><td>
+
+The names of the custom labels to add to the runner.
+
+</td></tr>
+  </tbody>
+</table>
+
+See also: [GitHub Developer Guide documentation](https://docs.github.com/rest/reference/actions#add-custom-labels-to-a-self-hosted-runner-for-a-repository).
diff --git a/docs/actions/addSelectedRepoToOrgSecret.md b/docs/actions/addSelectedRepoToOrgSecret.md
@@ -31,10 +31,12 @@ octokit.rest.actions.addSelectedRepoToOrgSecret({
   <tbody>
     <tr><td>org</td><td>yes</td><td>
 
+The organization name. The name is not case sensitive.
+
 </td></tr>
 <tr><td>secret_name</td><td>yes</td><td>
 
-secret_name parameter
+The name of the secret.
 
 </td></tr>
 <tr><td>repository_id</td><td>yes</td><td>

diff --git a/docs/actions/approveWorkflowRun.md b/docs/actions/approveWorkflowRun.md
@@ -33,13 +33,17 @@ octokit.rest.actions.approveWorkflowRun({
   <tbody>
     <tr><td>owner</td><td>yes</td><td>
 
+The account owner of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>repo</td><td>yes</td><td>
 
+The name of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run.
+The unique identifier of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/cancelWorkflowRun.md b/docs/actions/cancelWorkflowRun.md
@@ -31,13 +31,17 @@ octokit.rest.actions.cancelWorkflowRun({
   <tbody>
     <tr><td>owner</td><td>yes</td><td>
 
+The account owner of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>repo</td><td>yes</td><td>
 
+The name of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>run_id</td><td>yes</td><td>
 
-The id of the workflow run.
+The unique identifier of the workflow run.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/createOrUpdateEnvironmentSecret.md b/docs/actions/createOrUpdateEnvironmentSecret.md
@@ -38,7 +38,7 @@ console.log(encrypted);
 
 #### Example encrypting a secret using Python
 
-Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.
+Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
 
 ```
 from base64 import b64encode
@@ -106,6 +106,8 @@ octokit.rest.actions.createOrUpdateEnvironmentSecret({
   <tbody>
     <tr><td>repository_id</td><td>yes</td><td>
 
+The unique identifier of the repository.
+
 </td></tr>
 <tr><td>environment_name</td><td>yes</td><td>
 
@@ -114,7 +116,7 @@ The name of the environment
 </td></tr>
 <tr><td>secret_name</td><td>yes</td><td>
 
-secret_name parameter
+The name of the secret.
 
 </td></tr>
 <tr><td>encrypted_value</td><td>yes</td><td>

diff --git a/docs/actions/createOrUpdateOrgSecret.md b/docs/actions/createOrUpdateOrgSecret.md
@@ -38,7 +38,7 @@ console.log(encrypted);
 
 #### Example encrypting a secret using Python
 
-Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.
+Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
 
 ```
 from base64 import b64encode
@@ -104,10 +104,12 @@ octokit.rest.actions.createOrUpdateOrgSecret({
   <tbody>
     <tr><td>org</td><td>yes</td><td>
 
+The organization name. The name is not case sensitive.
+
 </td></tr>
 <tr><td>secret_name</td><td>yes</td><td>
 
-secret_name parameter
+The name of the secret.
 
 </td></tr>
 <tr><td>encrypted_value</td><td>no</td><td>
@@ -122,10 +124,7 @@ ID of the key you used to encrypt the secret.
 </td></tr>
 <tr><td>visibility</td><td>yes</td><td>
 
-Configures the access that repositories have to the organization secret. Can be one of:  
-\- `all` - All repositories in an organization can access the secret.  
-\- `private` - Private repositories in an organization can access the secret.  
-\- `selected` - Only specific repositories can access the secret.
+Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
 
 </td></tr>
 <tr><td>selected_repository_ids</td><td>no</td><td>

diff --git a/docs/actions/createOrUpdateRepoSecret.md b/docs/actions/createOrUpdateRepoSecret.md
@@ -38,7 +38,7 @@ console.log(encrypted);
 
 #### Example encrypting a secret using Python
 
-Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.
+Encrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/latest/public/#nacl-public-sealedbox) with Python 3.
 
 ```
 from base64 import b64encode
@@ -104,13 +104,17 @@ octokit.rest.actions.createOrUpdateRepoSecret({
   <tbody>
     <tr><td>owner</td><td>yes</td><td>
 
+The account owner of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>repo</td><td>yes</td><td>
 
+The name of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>secret_name</td><td>yes</td><td>
 
-secret_name parameter
+The name of the secret.
 
 </td></tr>
 <tr><td>encrypted_value</td><td>no</td><td>

diff --git a/docs/actions/createRegistrationTokenForOrg.md b/docs/actions/createRegistrationTokenForOrg.md
@@ -39,6 +39,8 @@ octokit.rest.actions.createRegistrationTokenForOrg({
   <tbody>
     <tr><td>org</td><td>yes</td><td>
 
+The organization name. The name is not case sensitive.
+
 </td></tr>
   </tbody>
 </table>

diff --git a/docs/actions/createRegistrationTokenForRepo.md b/docs/actions/createRegistrationTokenForRepo.md
@@ -39,9 +39,13 @@ octokit.rest.actions.createRegistrationTokenForRepo({
   <tbody>
     <tr><td>owner</td><td>yes</td><td>
 
+The account owner of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>repo</td><td>yes</td><td>
 
+The name of the repository. The name is not case sensitive.
+
 </td></tr>
   </tbody>
 </table>

diff --git a/docs/actions/createRemoveTokenForOrg.md b/docs/actions/createRemoveTokenForOrg.md
@@ -40,6 +40,8 @@ octokit.rest.actions.createRemoveTokenForOrg({
   <tbody>
     <tr><td>org</td><td>yes</td><td>
 
+The organization name. The name is not case sensitive.
+
 </td></tr>
   </tbody>
 </table>

diff --git a/docs/actions/createRemoveTokenForRepo.md b/docs/actions/createRemoveTokenForRepo.md
@@ -39,9 +39,13 @@ octokit.rest.actions.createRemoveTokenForRepo({
   <tbody>
     <tr><td>owner</td><td>yes</td><td>
 
+The account owner of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>repo</td><td>yes</td><td>
 
+The name of the repository. The name is not case sensitive.
+
 </td></tr>
   </tbody>
 </table>

diff --git a/docs/actions/createWorkflowDispatch.md b/docs/actions/createWorkflowDispatch.md
@@ -12,7 +12,7 @@ You can use this endpoint to manually trigger a GitHub Actions workflow run. You
 
 You must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see "[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch)."
 
-You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
+You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see "[Creating a personal access token for the command line](https://docs.github.com/articles/creating-a-personal-access-token-for-the-command-line)."
 
 ```js
 octokit.rest.actions.createWorkflowDispatch({
@@ -36,9 +36,13 @@ octokit.rest.actions.createWorkflowDispatch({
   <tbody>
     <tr><td>owner</td><td>yes</td><td>
 
+The account owner of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>repo</td><td>yes</td><td>
 
+The name of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>workflow_id</td><td>yes</td><td>
 

diff --git a/docs/actions/deleteArtifact.md b/docs/actions/deleteArtifact.md
@@ -31,13 +31,17 @@ octokit.rest.actions.deleteArtifact({
   <tbody>
     <tr><td>owner</td><td>yes</td><td>
 
+The account owner of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>repo</td><td>yes</td><td>
 
+The name of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>artifact_id</td><td>yes</td><td>
 
-artifact_id parameter
+The unique identifier of the artifact.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/deleteEnvironmentSecret.md b/docs/actions/deleteEnvironmentSecret.md
@@ -31,6 +31,8 @@ octokit.rest.actions.deleteEnvironmentSecret({
   <tbody>
     <tr><td>repository_id</td><td>yes</td><td>
 
+The unique identifier of the repository.
+
 </td></tr>
 <tr><td>environment_name</td><td>yes</td><td>
 
@@ -39,7 +41,7 @@ The name of the environment
 </td></tr>
 <tr><td>secret_name</td><td>yes</td><td>
 
-secret_name parameter
+The name of the secret.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/deleteOrgSecret.md b/docs/actions/deleteOrgSecret.md
@@ -30,10 +30,12 @@ octokit.rest.actions.deleteOrgSecret({
   <tbody>
     <tr><td>org</td><td>yes</td><td>
 
+The organization name. The name is not case sensitive.
+
 </td></tr>
 <tr><td>secret_name</td><td>yes</td><td>
 
-secret_name parameter
+The name of the secret.
 
 </td></tr>
   </tbody>

diff --git a/docs/actions/deleteRepoSecret.md b/docs/actions/deleteRepoSecret.md
@@ -31,13 +31,17 @@ octokit.rest.actions.deleteRepoSecret({
   <tbody>
     <tr><td>owner</td><td>yes</td><td>
 
+The account owner of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>repo</td><td>yes</td><td>
 
+The name of the repository. The name is not case sensitive.
+
 </td></tr>
 <tr><td>secret_name</td><td>yes</td><td>
 
-secret_name parameter
+The name of the secret.
 
 </td></tr>
   </tbody>