docs: sync README inputs with action.yml, update links and examples#94
docs: sync README inputs with action.yml, update links and examples#94brimal-ekline wants to merge 1 commit into
Conversation
- 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
🌟 EkLine ReviewerHello! 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. |
| @@ -5,76 +5,49 @@ | |||
| [](https://github.com/ekline-io/ekline-github-action/releases) | |||
| [](https://github.com/ekline-io/ekline-cli/pkgs/container/ekline-cli) | |||
There was a problem hiding this comment.
🚫 [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-ai The GitHub Actions integration reference on the docs site ( Update <!-- ekline-auto-trigger --> |
|
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. |
| content_dir: ./src/docs | ||
| ek_token: ${{ secrets.ek_token }} | ||
| github_token: ${{ secrets.github_token }} | ||
| github_token: ${{ github.token }} |
There was a problem hiding this comment.
Verified — the change is correct. Three reasons:
- Matches
action.yml. The action declaresgithub_token: default: '${{ github.token }}', so the example now reflects the action's own default instead of contradicting it. - 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. ${{ github.token }}and${{ secrets.GITHUB_TOKEN }}resolve to the same auto-provisioned token. Thegithub.tokencontext-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.
Summary
Brings the marketplace README in line with
action.ymlso users get accurate input docs and a working quick-start.Changes
docs.ekline.ioaction.yml(was 10): addsworkdir,level,fail_on_error,reviewdog_flags,enable_ai_suggestionsgithub_tokendefault reference:\${{ github.token }}(wassecrets)actions/checkoutto v4 in usage exampleenable_ai_suggestionsandfail_on_errorto examplegithub-pr-reviewreporter: PAT only needed outside ActionsTest plan
action.yml(count + defaults)