> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keephq.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Github Workflows

> GithubWorkflowProvider is a provider that interacts with Github Workflows API.

## Authentication

This provider requires authentication.

* **personal\_access\_token**: Github Personal Access Token (required: True, sensitive: True)

## In workflows

This provider can be used in workflows.

As "step" to query data, example:

```yaml theme={null}
steps:
    - name: Query github_workflows
      provider: github_workflows
      config: "{{ provider.my_provider_name }}"
      with:
        url: {value}  
        method: {value}  
```

As "action" to make changes or update data, example:

```yaml theme={null}
actions:
    - name: Query github_workflows
      provider: github_workflows
      config: "{{ provider.my_provider_name }}"
      with:
        github_url: {value}  
        github_method: {value}  
```

If you need workflow examples with this provider, please raise a [GitHub issue](https://github.com/keephq/keep/issues).

## Connecting with the Provider

Create your personal access token (classic) in github

* In the upper-right corner of any page, click your profile photo, then click **Settings**.
* In the left sidebar, click **Developer settings**.
* In the left sidebar, under  Personal access tokens, click **Tokens (classic)**.
* Select Generate new token, then click Generate new **token (classic)**.
* In the "Note" field, give your token a descriptive name.
* To give your token an expiration, select **Expiration**, then choose a default option or click **Custom** to enter a date.
* Select the scopes you'd like to grant this token.
* Click **Generate token**.
* Optionally, to copy the new token to your clipboard, click copy button.

See bellow for more info.

## Useful Links

* [Workflows](https://docs.github.com/en/rest/actions/workflows)
* [Workflows runs](https://docs.github.com/en/rest/actions/workflow-runs)
* [Workflows jobs](https://docs.github.com/en/rest/actions/workflow-jobs)
* [Managing your personal access tokens](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)