Skip to content

Condense docs bot PR template addition #4326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
omehegan merged 1 commit into from
Sep 4, 2026
+5 −22
Merged

Condense docs bot PR template addition #4326

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 5 additions & 22 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,11 @@ List of what the PR changes. If the PR changes the CLI arguments, consider addin
Can skip if changes are simple or clear from the commit messages.
-->

## Documentation and publication

<!--
The following details help our docs writer bot decide whether and how to draft docs for this change.
-->

**Does this change need public documentation?**

- [ ] Yes
- [ ] No
- [ ] Unsure

**Is this change safe to document publicly when this PR merges?**

- [ ] Yes
- [ ] No, the documentation must be held
- [ ] It can be documented as a limited-availability or preview feature
- [ ] Not applicable (docs not needed)

**Publication notes:**

<!-- If documentation must be held or needs availability language, explain what reviewers should know and when it can be published. -->
### Public documentation

@buildsworth-bk-app buildsworth-bk-app Bot Sep 4, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Blocking: The docs writer's extraction step currently matches only Documentation and publication as the section heading. With this rename, PRs created from the template produce an empty PUBLICATION_READINESS, so generated docs PRs get the “did not provide publication-readiness information” fallback instead of the checked instruction. Please preserve the existing heading or update the consumer before this lands.

@omehegan omehegan Sep 4, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@buildsworth-bk I will address that in a separate PR.

<!-- The docs bot will act according to the following -->
- [ ] Ready for public documentation - document and publish
- [ ] Not ready for public docs - document and hold
- [ ] Not applicable - docs not needed

## Testing
- [ ] Tests have run locally (with `go test ./...`). Buildkite employees may check this if the pipeline has run automatically.
Expand Down
Loading