This guide explains how to use GitHub features with sKaleQL, including setting up authentication, running workflows, and accessing query results through GitHub Actions.

## Table of Contents

- [Using This Template](#using-this-template)
- [Setting Secret Values](#setting-secret-values)
- [Executing KQL Queries](#executing-kql-queries)
- [Viewing Query Results](#viewing-query-results)
- [Downloading Artifacts](#downloading-artifacts)

## Using This Template

To create a new repository using this template:

1. Navigate to the [kql-template-repo](https://github.com/christosgalano/kql-template-repo) repository.
2. Click **Use this template**.
3. Select **Create a new repository**.

![Using Template](assets/images/github/use-template.png)

## Setting Secret Values

To configure the necessary secrets for the repository, set the following values:

- **AZURE_CLIENT_ID**: Client ID of the Service Principal.
- **AZURE_SUBSCRIPTION_ID**: Subscription ID containing the Log Analytics Workspace.
- **AZURE_TENANT_ID**: Tenant ID of the Service Principal.
- **WORKSPACE_ID**: ID of the Log Analytics Workspace.

### Steps to set secrets

1. Navigate to **Settings** > **Secrets and variables** > **Actions**.
2. Click **New repository secret**.
3. Enter the name and value of the secret.
4. Click **Add secret**.

![Set Secrets](assets/images/github/set-secrets.png)

## Executing KQL Queries

1. Go to the **Actions** tab and select the **execute-queries** workflow.
2. Click **Run workflow**.
3. Enter the folder containing the KQL queries relative to `library` (e.g., `device`).
4. Click **Run workflow**.

![Run Workflow](assets/images/github/run-workflow.png)

## Viewing Query Results

1. Click on the workflow run to view the details.
2. Click on the **Execute queries in <folder>** job.
3. Click on the **Execute queries** step.

![Workflow Running](assets/images/examples/workflow-running.png)

![Workflow Output](assets/images/examples/workflow-output.png)

## Downloading Artifacts

1. Go to the workflow run.
2. Under **Artifacts**, click on **Query-Results**.

![Workflow Overview](assets/images/examples/workflow-overview.png)

<p align="center">
  <img src="assets/images/examples/workflow-artifact.png" alt="Workflow Artifact">
</p>

## Next Steps

With your GitHub setup complete, you can now familiarize yourself with the [configuration options](https://github.com/christosgalano/kql-template-repo/wiki/Configuration).