📖 [Docs]: Update scripts README documentation#159
Conversation
No Significant Changes DetectedThis PR does not contain changes to files that would trigger a new release:
Build, test, and publish stages will be skipped for this PR. If you believe this is incorrect, please verify that your changes are in the correct locations. |
There was a problem hiding this comment.
Pull request overview
Updates scripts/README.md to better reflect the current behavior and formatting conventions of the font data updater documentation, including newly documented branch cleanup during PR supersedence (Fixes #158).
Changes:
- Adds documentation that superseded PR branches are deleted as part of the updater’s supersedence flow.
- Improves markdown readability via line wrapping and consistent spacing around fenced code blocks.
- Clarifies/reshapes wording in PR lifecycle and development guidance sections.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| 5. **PR Supersedence**: After creating a new PR, the script: | ||
| - Searches for existing open PRs with titles matching `Auto-Update*` (excluding the newly created PR) | ||
| - Closes each superseded PR with a comment referencing the new PR number | ||
| - Deletes the branches associated with superseded PRs |
There was a problem hiding this comment.
Documentation says the script searches for PR titles matching Auto-Update*, but Update-FontsData.ps1 actually uses gh pr list --search 'Auto-Update in:title', which matches any title containing Auto-Update (not necessarily a prefix/wildcard pattern). Consider rewording to "titles containing 'Auto-Update'" to reflect the actual search behavior.
| - The script first creates the new PR | ||
| - Then checks for existing open `Auto-Update*` PRs (excluding the newly created one) | ||
| - Each existing PR receives a comment referencing the new PR number: |
There was a problem hiding this comment.
Same as above: this section describes checking for existing open Auto-Update* PRs, but the script’s query is Auto-Update in:title (contains match). Rewording this to a contains match would keep the README aligned with the implementation.
| ``` | ||
|
|
||
| - All superseded PRs are automatically closed | ||
| - Branches for closed PRs are deleted |
There was a problem hiding this comment.
"Branches for closed PRs are deleted" is a bit broader than what the script does: it deletes branches for PRs it closes as part of supersedence (existing open Auto-Update PRs). Suggest rephrasing to "Branches for superseded PRs are deleted" (optionally noting deletion is best-effort).
| - Branches for closed PRs are deleted | |
| - Branches for superseded PRs are deleted (best-effort) |
1 participant
Updates the scripts README with improved accuracy, missing details, and markdown style consistency. The documentation now fully reflects the current behavior of the font data updater, including branch cleanup for superseded PRs.
Branch cleanup documentation
Added missing documentation about branch deletion for superseded PRs. The
Update-FontsData.ps1script deletes branches associated with closed superseded PRs, which was previously undocumented.Markdown style fixes