Set up EkLine Docs Reviewer as a GitHub Action
Set up the Docs Reviewer GitHub Action so every pull request gets a docs review.
Before you begin
Section titled “Before you begin”- An EkLine account, with access to the EkLine Dashboard.
- A GitHub repository where you can add repository secrets and workflow files.
-
Copy your token
Go to Settings > Organization > Access in the EkLine Dashboard and copy your integration token.
-
Add it to GitHub
In your repository, go to Settings > Secrets and variables > Actions and click New repository secret.
Field Value Name EK_TOKENSecret your token
-
Create the workflow. Go to Actions > New workflow > set up a workflow yourself.
Add this file to your repo at
.github/workflows/ekline.yml:name: EkLineon: [pull_request]jobs:docs:runs-on: ubuntu-latestpermissions:contents: readpull-requests: writesteps:- uses: actions/checkout@v4- uses: ekline-io/ekline-github-action@v6with:content_dir: .ek_token: ${{ secrets.EK_TOKEN }}github_token: ${{ secrets.GITHUB_TOKEN }}reporter: github-pr-review -
Open a PR
Commit the workflow and open a pull request. EkLine reviews it automatically.
That’s it
Section titled “That’s it”You can see inline comments on your PR like:
EK00005: Where possible, don’t structure sentences in future tense. Use present tense instead.
Stuck?
Section titled “Stuck?”Reply to your welcome email or contact support@ekline.io. We read every message.
Want more control?
Section titled “Want more control?”Built on Potluck Docs, our open source template.