Skip to content

Commit

Permalink
doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
@jeffreyaven
jeffreyaven committed May 3, 2024
1 parent 02ebc75 commit 266797d
Show file tree
Hide file tree
Showing 316 changed files with 6,519 additions and 5,516 deletions.
16 changes: 9 additions & 7 deletions docs/github-docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,22 @@ custom_edit_url: null
image: /img/providers/github/stackql-github-provider-featured-image.png
id: github-doc
slug: /providers/github

---

import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';

Web-based version-control and collaboration.

:::info Provider Summary (v23.09.00175)
:::info Provider Summary (v24.04.00227)

<div class="row">
<div class="providerDocColumn">
<span>total services:&nbsp;<b>31</b></span><br />
<span>total methods:&nbsp;<b>883</b></span><br />
<span>total methods:&nbsp;<b>885</b></span><br />
</div>
<div class="providerDocColumn">
<span>total resources:&nbsp;<b>278</b></span><br />
<span>total selectable resources:&nbsp;<b>273</b></span><br />
<span>total resources:&nbsp;<b>281</b></span><br />
<span>total selectable resources:&nbsp;<b>276</b></span><br />
</div>
</div>

Expand All @@ -49,8 +51,8 @@ REGISTRY PULL github;

The following system environment variables are used for authentication by default:

- `STACKQL_GITHUB_USERNAME` - GitHub username (login)
- `STACKQL_GITHUB_PASSWORD` - GitHub Personal Access Token (see [Creating a personal access token](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token))
- <CopyableCode code="STACKQL_GITHUB_USERNAME" /> - GitHub username (login)
- <CopyableCode code="STACKQL_GITHUB_PASSWORD" /> - GitHub Personal Access Token (see [Creating a personal access token](https://docs.github.com/en/[email protected]/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token))

These variables are sourced at runtime (from the local machine or as CI variables/secrets).

Expand Down
23 changes: 13 additions & 10 deletions docs/github-docs/providers/github/actions/allowed_actions/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,29 @@ description: Query, deploy and manage GitHub resources using SQL
custom_edit_url: null
image: /img/providers/github/stackql-github-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>allowed_actions</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>github.actions.allowed_actions</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="github.actions.allowed_actions" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `github_owned_allowed` | `boolean` | Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. |
| `patterns_allowed` | `array` | Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.<br /><br />**Note**: The `patterns_allowed` setting only applies to public repositories. |
| `verified_allowed` | `boolean` | Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. |
| <CopyableCode code="github_owned_allowed" /> | `boolean` | Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization. |
| <CopyableCode code="patterns_allowed" /> | `array` | Specifies a list of string-matching patterns to allow specific action(s) and reusable workflow(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.<br /><br />**Note**: The `patterns_allowed` setting only applies to public repositories. |
| <CopyableCode code="verified_allowed" /> | `boolean` | Whether actions from GitHub Marketplace verified creators are allowed. Set to `true` to allow all actions by GitHub Marketplace verified creators. |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get_allowed_actions_organization` | `SELECT` | `org` | Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).""<br /><br />You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. |
| `get_allowed_actions_repository` | `SELECT` | `owner, repo` | Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. |
| `set_allowed_actions_organization` | `EXEC` | `org` | Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."<br /><br />You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. |
| `set_allowed_actions_repository` | `EXEC` | `owner, repo` | Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. |
| <CopyableCode code="get_allowed_actions_organization" /> | `SELECT` | <CopyableCode code="org" /> | Gets the selected actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).""<br /><br />You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. |
| <CopyableCode code="get_allowed_actions_repository" /> | `SELECT` | <CopyableCode code="owner, repo" /> | Gets the settings for selected actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. |
| <CopyableCode code="set_allowed_actions_organization" /> | `EXEC` | <CopyableCode code="org" /> | Sets the actions and reusable workflows that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization)."<br /><br />You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API. |
| <CopyableCode code="set_allowed_actions_repository" /> | `EXEC` | <CopyableCode code="owner, repo" /> | Sets the actions and reusable workflows that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see "[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository)."<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API. |
41 changes: 22 additions & 19 deletions docs/github-docs/providers/github/actions/artifacts/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,35 +14,38 @@ description: Query, deploy and manage GitHub resources using SQL
custom_edit_url: null
image: /img/providers/github/stackql-github-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>artifacts</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>github.actions.artifacts</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="github.actions.artifacts" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `id` | `integer` | |
| `name` | `string` | The name of the artifact. |
| `created_at` | `string` | |
| `updated_at` | `string` | |
| `expired` | `boolean` | Whether or not the artifact has expired. |
| `node_id` | `string` | |
| `archive_download_url` | `string` | |
| `workflow_run` | `object` | |
| `size_in_bytes` | `integer` | The size in bytes of the artifact. |
| `url` | `string` | |
| `expires_at` | `string` | |
| <CopyableCode code="id" /> | `integer` | |
| <CopyableCode code="name" /> | `string` | The name of the artifact. |
| <CopyableCode code="archive_download_url" /> | `string` | |
| <CopyableCode code="created_at" /> | `string` | |
| <CopyableCode code="expired" /> | `boolean` | Whether or not the artifact has expired. |
| <CopyableCode code="expires_at" /> | `string` | |
| <CopyableCode code="node_id" /> | `string` | |
| <CopyableCode code="size_in_bytes" /> | `integer` | The size in bytes of the artifact. |
| <CopyableCode code="updated_at" /> | `string` | |
| <CopyableCode code="url" /> | `string` | |
| <CopyableCode code="workflow_run" /> | `object` | |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get_artifact` | `SELECT` | `artifact_id, owner, repo` | Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. |
| `list_artifacts_for_repo` | `SELECT` | `owner, repo` | Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. |
| `list_workflow_run_artifacts` | `SELECT` | `owner, repo, run_id` | Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. |
| `delete_artifact` | `DELETE` | `artifact_id, owner, repo` | Deletes an artifact for a workflow run. 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. |
| `download_artifact` | `EXEC` | `archive_format, artifact_id, owner, repo` | Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in<br />the response header to find the URL for the download. The `:archive_format` must be `zip`.<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint.<br />GitHub Apps must have the `actions:read` permission to use this endpoint. |
| <CopyableCode code="get_artifact" /> | `SELECT` | <CopyableCode code="artifact_id, owner, repo" /> | Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. |
| <CopyableCode code="list_artifacts_for_repo" /> | `SELECT` | <CopyableCode code="owner, repo" /> | Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. |
| <CopyableCode code="list_workflow_run_artifacts" /> | `SELECT` | <CopyableCode code="owner, repo, run_id" /> | Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. |
| <CopyableCode code="delete_artifact" /> | `DELETE` | <CopyableCode code="artifact_id, owner, repo" /> | Deletes an artifact for a workflow run. 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. |
| <CopyableCode code="download_artifact" /> | `EXEC` | <CopyableCode code="archive_format, artifact_id, owner, repo" /> | Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in<br />the response header to find the URL for the download. The `:archive_format` must be `zip`.<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint.<br />GitHub Apps must have the `actions:read` permission to use this endpoint. |
19 changes: 11 additions & 8 deletions docs/github-docs/providers/github/actions/cache/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,27 @@ description: Query, deploy and manage GitHub resources using SQL
custom_edit_url: null
image: /img/providers/github/stackql-github-provider-featured-image.png
---



import CopyableCode from '@site/src/components/CopyableCode/CopyableCode';




## Overview
<table><tbody>
<tr><td><b>Name</b></td><td><code>cache</code></td></tr>
<tr><td><b>Type</b></td><td>Resource</td></tr>
<tr><td><b>Id</b></td><td><code>github.actions.cache</code></td></tr>
<tr><td><b>Id</b></td><td><CopyableCode code="github.actions.cache" /></td></tr>
</tbody></table>

## Fields
| Name | Datatype | Description |
|:-----|:---------|:------------|
| `actions_caches` | `array` | Array of caches |
| `total_count` | `integer` | Total number of caches |
| <CopyableCode code="actions_caches" /> | `array` | Array of caches |
| <CopyableCode code="total_count" /> | `integer` | Total number of caches |
## Methods
| Name | Accessible by | Required Params | Description |
|:-----|:--------------|:----------------|:------------|
| `get_actions_cache_list` | `SELECT` | `owner, repo` | Lists the GitHub Actions caches for a repository.<br />You must authenticate using an access token with the `repo` scope to use this endpoint.<br />GitHub Apps must have the `actions:read` permission to use this endpoint. |
| `delete_actions_cache_by_id` | `DELETE` | `cache_id, owner, repo` | Deletes a GitHub Actions cache for a repository, using a cache ID.<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint.<br /><br />GitHub Apps must have the `actions:write` permission to use this endpoint. |
| `delete_actions_cache_by_key` | `DELETE` | `key, owner, repo` | Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint.<br /><br />GitHub Apps must have the `actions:write` permission to use this endpoint. |
| <CopyableCode code="get_actions_cache_list" /> | `SELECT` | <CopyableCode code="owner, repo" /> | Lists the GitHub Actions caches for a repository.<br />You must authenticate using an access token with the `repo` scope to use this endpoint.<br />GitHub Apps must have the `actions:read` permission to use this endpoint. |
| <CopyableCode code="delete_actions_cache_by_id" /> | `DELETE` | <CopyableCode code="cache_id, owner, repo" /> | Deletes a GitHub Actions cache for a repository, using a cache ID.<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint.<br /><br />GitHub Apps must have the `actions:write` permission to use this endpoint. |
| <CopyableCode code="delete_actions_cache_by_key" /> | `DELETE` | <CopyableCode code="key, owner, repo" /> | Deletes one or more GitHub Actions caches for a repository, using a complete cache key. By default, all caches that match the provided key are deleted, but you can optionally provide a Git ref to restrict deletions to caches that match both the provided key and the Git ref.<br /><br />You must authenticate using an access token with the `repo` scope to use this endpoint.<br /><br />GitHub Apps must have the `actions:write` permission to use this endpoint. |
Loading

0 comments on commit 266797d

Please sign in to comment.