docs: Documentation analysis and improvement#946
Merged
Conversation
Co-authored-by: Copilot <[email protected]>
v1v
approved these changes
May 11, 2026
Contributor
There was a problem hiding this comment.
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 fallbackno-testworkflow provides the requiredtestjob. - Corrects guidance that
!<action-path>/**entries inno-test.ymlare exclusions for actions with dedicatedtest-*.ymlworkflows, and adds a concrete example (aws/auth+test-aws-auth.yml).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #945
Summary of files analyzed
docs/CONTRIBUTING.md.github/workflows/no-test.yml.github/workflows/test-aws-auth.ymloblt-cli/deploy-my-kibana/README.mdoblt-cli/undeploy-my-kibana/README.mdoblt-cli/deploy-my-kibana/action.ymloblt-cli/undeploy-my-kibana/action.ymlIssues found
docs/CONTRIBUTING.md: Theno-test.ymlguidance incorrectly said to add!<action-path>/**for actions without dedicated tests; inno-test.yml, those negated paths are exclusions for actions that already have dedicatedtest-*.ymlworkflows.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.mdin the Action Testing and.github/workflows/no-test.ymlsections to document the real trigger behavior:no-test.ymlstarts from**and exclusions (!<action-path>/**) are for actions that already have dedicated test workflows.no-testprovides the requiredtestjob.aws/authwithtest-aws-auth.yml) and clarified fallback behavior.Left
oblt-cli/deploy-my-kibana/README.mdandoblt-cli/undeploy-my-kibana/README.mdunchanged 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.