Skip to content

docs: Documentation analysis and improvement#946

Merged
v1v merged 2 commits into
mainfrom
docs-issue-945-9f2b3ecf8a0c0f7e
May 11, 2026
Merged

docs: Documentation analysis and improvement#946
v1v merged 2 commits into
mainfrom
docs-issue-945-9f2b3ecf8a0c0f7e

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions Bot commented May 7, 2026

Closes #945

Summary of files analyzed

  • docs/CONTRIBUTING.md
  • .github/workflows/no-test.yml
  • .github/workflows/test-aws-auth.yml
  • oblt-cli/deploy-my-kibana/README.md
  • oblt-cli/undeploy-my-kibana/README.md
  • oblt-cli/deploy-my-kibana/action.yml
  • oblt-cli/undeploy-my-kibana/action.yml

Issues found

  • docs/CONTRIBUTING.md: The no-test.yml guidance incorrectly said to add !<action-path>/** for actions without dedicated tests; in no-test.yml, those negated paths are exclusions for actions that already have dedicated test-*.yml workflows.
  • oblt-cli/deploy-my-kibana/README.md: Authentication wording says “exactly one authentication mode,” but action validation only rejects two cases: all auth inputs empty, or all three set.
  • oblt-cli/undeploy-my-kibana/README.md: Same authentication wording mismatch with current validation behavior.

Changes made

  • Updated docs/CONTRIBUTING.md in the Action Testing and .github/workflows/no-test.yml sections to document the real trigger behavior:

    • no-test.yml starts from ** and exclusions (!<action-path>/**) are for actions that already have dedicated test workflows.
    • Actions without dedicated test workflows must remain included so fallback no-test provides the required test job.
    • Added a concrete dedicated-test example (aws/auth with test-aws-auth.yml) and clarified fallback behavior.
  • Left oblt-cli/deploy-my-kibana/README.md and oblt-cli/undeploy-my-kibana/README.md unchanged because they are marked auto-generated (Generated by https://github.com/reakaleek/gh-action-readme). Per docs-only guardrails, those updates should be made through the readme generation source/template/hook flow rather than by hand-editing generated output.


What is this? | From workflow: Observability Agentic Workflow Entrypoint

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@github-actions github-actions Bot added the changelog:docs When you add or update documentation label May 7, 2026
@v1v v1v marked this pull request as ready for review May 11, 2026 12:22
@v1v v1v requested a review from a team as a code owner May 11, 2026 12:22
Copilot AI review requested due to automatic review settings May 11, 2026 12:22
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates contributor documentation to accurately describe how the repository’s required test check is satisfied, clarifying the relationship between dedicated test-*.yml workflows and the fallback .github/workflows/no-test.yml workflow.

Changes:

  • Clarifies that actions without dedicated test workflows should remain included in no-test.yml (via the default ** path), so the fallback no-test workflow provides the required test job.
  • Corrects guidance that !<action-path>/** entries in no-test.yml are exclusions for actions with dedicated test-*.yml workflows, and adds a concrete example (aws/auth + test-aws-auth.yml).

@v1v v1v added this pull request to the merge queue May 11, 2026
Merged via the queue into main with commit 80cb988 May 11, 2026
24 checks passed
@v1v v1v deleted the docs-issue-945-9f2b3ecf8a0c0f7e branch May 11, 2026 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog:docs When you add or update documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[oblt-aw][autodoc] Fix incorrect auth-mode and no-test guidance in docs

2 participants