Skip to content

ci: handle all package documentation edits#18894

Open
shmsr wants to merge 2 commits into
elastic:mainfrom
shmsr:fix/docs-edit-helper-all-md
Open

ci: handle all package documentation edits#18894
shmsr wants to merge 2 commits into
elastic:mainfrom
shmsr:fix/docs-edit-helper-all-md

Conversation

@shmsr
Copy link
Copy Markdown
Member

@shmsr shmsr commented May 8, 2026

Summary

  • Expand the Documentation edit helper workflow to cover all flat package source docs under packages/*/_dev/build/docs/*.md, including per-data-stream files like cloudtrail.md.
  • Require both manifest.yml and changelog.yml before considering a docs package complete, and report partial metadata updates separately.
  • Harden generated changelog commands by safely passing custom 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.yml
  • Focused shell check for custom changelog: parsing with shell-sensitive text.
  • Focused shell check for metadata classification: no metadata, complete metadata, missing manifest, and missing changelog.

@shmsr shmsr requested a review from a team as a code owner May 8, 2026 08:14
@shmsr shmsr self-assigned this 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'
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

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

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