ci: handle all package documentation edits#18894
Open
shmsr wants to merge 2 commits into
Open
Conversation
5 tasks
mrodm
reviewed
May 8, 2026
| # directory. This covers both the package-level README.md and | ||
| # per-integration/per-data-stream files such as cloudtrail.md, | ||
| # activitylogs.md, gke.md, etc. | ||
| - 'packages/*/_dev/build/docs/*.md' |
Collaborator
There was a problem hiding this comment.
Would this pattern match packages in nested directories ?
Like packages/nginx/nginx_otel/ ?
There are still no packages located in nested directories, but it would be good that all these processes support that too to be prepared.
Related to this issue: #17403
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.
Summary
packages/*/_dev/build/docs/*.md, including per-data-stream files likecloudtrail.md.manifest.ymlandchangelog.ymlbefore considering a docs package complete, and report partial metadata updates separately.changelog:text between steps and shell-quoting it in the suggested command.Test plan
go run github.com/rhysd/actionlint/cmd/actionlint@latest .github/workflows/docs-edit-automation.ymlchangelog:parsing with shell-sensitive text.