Skip to content

docs: sync README inputs with action.yml, update links and examples#94

Open
brimal-ekline wants to merge 1 commit into
mainfrom
docs/marketplace-readme-refresh
Open

docs: sync README inputs with action.yml, update links and examples#94
brimal-ekline wants to merge 1 commit into
mainfrom
docs/marketplace-readme-refresh

Conversation

@brimal-ekline

Copy link
Copy Markdown

Summary

Brings the marketplace README in line with action.yml so users get accurate input docs and a working quick-start.

Changes

  • Replace deprecated Notion link with docs.ekline.io
  • Document all 15 inputs from action.yml (was 10): adds workdir, level, fail_on_error, reviewdog_flags, enable_ai_suggestions
  • Fix github_token default reference: \${{ github.token }} (was secrets)
  • Bump actions/checkout to v4 in usage example
  • Add commented enable_ai_suggestions and fail_on_error to example
  • Clarify github-pr-review reporter: PAT only needed outside Actions
  • Restructure inputs as a table; rebuild TOC; close stray code fence

Test plan

  • Render README on the branch and confirm TOC links resolve
  • Confirm input table matches action.yml (count + defaults)
  • Verify the usage example copies cleanly into a fresh workflow

- Replace deprecated Notion link with docs.ekline.io
- Document all 15 inputs from action.yml (was 10): adds workdir, level,
  fail_on_error, reviewdog_flags, enable_ai_suggestions
- Fix github_token default reference: ${{ github.token }} (was secrets)
- Bump actions/checkout to v4 in usage example
- Add commented enable_ai_suggestions and fail_on_error to example
- Clarify github-pr-review reporter: PAT only needed outside Actions
- Restructure inputs as a table; rebuild TOC; close stray code fence
@github-actions

github-actions Bot commented May 7, 2026

Copy link
Copy Markdown

🌟 EkLine Reviewer

Hello! I’m here to help improve your docs. I’ve reviewed your pull request, and left in-line suggestions for quick fixes.

For questions or feedback, please email support@ekline.io.

Comment thread README.md
Comment thread README.md
Comment thread README.md
@@ -5,76 +5,49 @@
[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/ekline-io/ekline-github-action?logo=github&sort=semver)](https://github.com/ekline-io/ekline-github-action/releases)
[![release](https://ghcr-badge.egpl.dev/ekline-io/ekline-ci-cd/latest_tag?label=Docker%20version%20ekline_ci_cd)](https://github.com/ekline-io/ekline-cli/pkgs/container/ekline-cli)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] <EK20001>

Confirm the link. The URL 'https://github.com/ekline-io/ekline-cli/pkgs/container/ekline-cli' seems inaccessible with error code 404. It might be incorrect or improperly formatted. (EK20001)

@ekline

ekline Bot commented May 7, 2026

Copy link
Copy Markdown

@ekline-ai The GitHub Actions integration reference on the docs site (reviewer/integrations/github-integration.mdx) is now out of sync with the corrected inputs in this PR. It lists only 8 of 15 inputs (missing workdir, level, fail_on_error, reviewdog_flags, enable_ai_suggestions), shows the wrong github_token default (${{ secrets.github_token }} instead of ${{ github.token }}), and incorrectly states a PAT is required for github-pr-review. The quickstart at reviewer/quickstart/github-action.mdx also uses the old ${{ secrets.GITHUB_TOKEN }} token reference.

Update github-integration.mdx to add the 5 missing inputs, fix the github_token default, and correct the github-pr-review reporter description. Update github-action.mdx to use ${{ github.token }}. Create the documentation updates as drafts in the workspace.

<!-- ekline-auto-trigger -->

@ekline

ekline Bot commented May 7, 2026

Copy link
Copy Markdown

EkLine Docs Agent has opened a docs PR with the update for this PR.

You can also make edits to the docs PR in EkLine Editor.

Comment thread README.md
content_dir: ./src/docs
ek_token: ${{ secrets.ek_token }}
github_token: ${{ secrets.github_token }}
github_token: ${{ github.token }}

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brimal-ekline I am not sure if this is right

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Verified — the change is correct. Three reasons:

  1. Matches action.yml. The action declares github_token: default: '${{ github.token }}', so the example now reflects the action's own default instead of contradicting it.
  2. No duplicate key in the rendered file. Grepping the README on this branch shows a single github_token: line in the workflow example (line 76). What looks like two stacked lines in the diff is the unified-diff artifact: the - (old) line above the + (new) line — only the + lands in the file.
  3. ${{ github.token }} and ${{ secrets.GITHUB_TOKEN }} resolve to the same auto-provisioned token. The github.token context-object form is the canonical one in GitHub's current docs and is what most modern actions use.

Safe to merge from a correctness standpoint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants