Skip to content
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 23 additions & 16 deletions _docs/integrations/github-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,29 @@ jobs:

Adjust the configuration options as needed for your specific use case. The available options are:

- **`content_dir`**: The content directory relative to the root directory (default: **`.`**).
- **`ek_token`**: The token for the EkLine application (required).
- **`filter_mode`**: The filtering mode for the EkLine reviewer command [added, diff_context, file, nofilter] (default: **`added`**).
- **`github_token`**: The GITHUB_TOKEN (default: **`${{ secrets.github_token }}`**).
- **`reporter`**: The reporter of the EkLine review command [github-pr-check, github-check, github-pr-review] (default: **`github-pr-check`**).
- **`content_dir`**: The content directory relative to the root directory. The default is **`.`**.
- **`ek_token`**: The token for the EkLine app, required.
- **`filter_mode`**: The filtering mode for the EkLine reviewer command includes added, diff context, file, and no filter, with the default being **`added`**.
- **`github_token`**: The GITHUB_TOKEN, default: **`${{ secrets.github_token }}`**.
- **`reporter`**: The reporter of the EkLine review command: github-pr-check, github-check, github-pr-review. The default is **`github-pr-check`**.

### More configuration options and environment variables

#### `notifyTimeoutMs` Configuration Option

The `notifyTimeoutMs` is an optional property that allows users to configure a timeout for event bus polling requests. This configuration helps prevent long-running requests, enhances system robustness, and provides better control over the duration the system waits for events before timing out.

#### `EVENTS_NOTIFY_TIMEOUT_HEADER` Constant

The `EVENTS_NOTIFY_TIMEOUT_HEADER` constant communicates the timeout setting to client-side logic in event bus polling. This header ensures that the client respects the configured timeout, aiding in efficient event processing and handling potential network delays or server-side timeouts.

### Filter Modes

You can control how the EkLine reviewer filters results by specifying the **`filter_mode`** option. Available filter modes are as below:

- **`added`** (default): Filter results by added or modified lines.
- **`diff_context`**: Filter results by diff context. That's, changed lines +-N lines (N=3, for example).
- **`file`**: Filter results by added or modified file. EkLine reviewer will report results as long as they are in an added or modified file, even if the results aren't in the actual diff.
- **`added`** default: Filter results by added or modified lines.
- **`diff_context`**: Filter results by diff context. That's, changed lines plus or minus N lines; for example, N=3.
- **`file`**: Filter results by added or modified file. EkLine reviewer reports results as long as they are in an added or modified file, even if the results aren't in the actual diff.
- **`nofilter`**: Don't filter any results. Useful for posting results as comments as much as possible and checking other results in the console simultaneously.

### Reporter Types
Expand All @@ -81,12 +91,11 @@ For example, if you want to ignore rules `EK00001` and `EK00004`, you can set th

## Save and commit the workflow file

After configuring the workflow file, click "Start commit" to save and commit the file to your repository. The EkLine GitHub Action will now run automatically when you push changes to the **`master`** or **`main`** branches or create a pull request.
After configuring the workflow file, click "Start commit" to save and commit the file to your repository. The EkLine GitHub Action now runs automatically when you push changes to the **`master`** or **`main`** branches or create a pull request.

## Add the EkLine API token to your repository secrets

Before the action can work, you need to provide the EkLine API token. Go to your repository settings, navigate to the "Secrets" tab, and add a new secret with the name **`ek_token`**. Paste your EkLine API token as the value.

Before the action can work, you need to give the EkLine API token. Go to your repository settings, navigate to the "Secrets" tab, and add a new secret with the name **`ek_token`**. Paste your EkLine API token as the value.

<img
className={'rounded-2xl'}
Expand All @@ -100,8 +109,7 @@ Before the action can work, you need to provide the EkLine API token. Go to your

To enable the EkLine GitHub Action to add comments to pull requests, you must grant write permissions to workflows.

To do this, navigate to **Settings > Code and Automation > Actions > General > Workflow permissions**. Then, click the drop-down menu and select **"Read and write permissions"**. Click on **"Save"** to apply the changes.

To do this, navigate to **Settings > Code and Automation > Actions > General > Workflow permissions**. Then, click the drop-down menu and select **"Read and write permissions"**. Click **"Save"** to apply the changes.

<img
className={'rounded-2xl'}
Expand All @@ -111,13 +119,12 @@ To do this, navigate to **Settings > Code and Automation > Actions > General > W
alt={`Grant Write Permissions to Workflows`}
/>


## Monitor the EkLine GitHub Action results
## Check the EkLine GitHub Action results

Once the EkLine GitHub Action runs, you can view the results in the "Actions" tab of your repository.

Now, you have integrated the EkLine GitHub Action into your repository for automated documentation review. Enjoy better quality and consistency in your documentation.

### Other options:
### Other options

[EkLine GitHub Action on Label](/documentation/github-action-label)