DOC-13521 calculate staging playbook #840
Conversation
Rationale: as well as the staging playbook, we now have to manage: * the template preview playbook * 1+ playbooks for chatbot * escrow playbook All of which need to be kept in sync with the main playbook, preserving just important differences. As the staging playbook is the most high-profile one with likely the most complexity in setting it up, I'm starting with that, to check that we can do this fully enough to support the requirement. (The preview one is currently supported by the more straight-forward scripts/patch-preview-playbook, but could use the same code.)
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a script to generate staging playbooks by calculating differences from the main playbook configuration. The solution aims to help maintain multiple playbooks (staging, template preview, chatbot, and escrow) while keeping them synchronized with the main playbook while preserving important differences.
Key changes:
- New
patch-cutdown-playbookscript that merges a base playbook with difference configurations - Addition of
picomatchdependency for pattern matching functionality - Generated staging playbook file with warning header indicating it's auto-generated
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/patch-cutdown-playbook | New Node.js script that reads base playbook and diff files, merges configurations with custom logic for sources and branches |
| package.json | Adds picomatch dependency for glob pattern matching |
| antora-playbook-staging.yml | Generated staging playbook with auto-generated warning header and merged configuration |
Comments suppressed due to low confidence (2)
scripts/patch-cutdown-playbook:1
- The branch name 'mai' appears to be incomplete. It should be 'main'.
#!/usr/bin/env node
scripts/patch-cutdown-playbook:1
- The branch name 'tut' appears to be incomplete. It should be 'tutorials'.
#!/usr/bin/env node
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
| branches: | ||
| - temp/4.3 | ||
| - temp/4.2 | ||
| - release/4.1 |
There was a problem hiding this comment.
PHP 4.1 has just gone EOL - I'll be removing from the main playbook later.
There was a problem hiding this comment.
great, that should update automagically the next time I run the script...
| branches: | ||
| - temp/3.6 | ||
| - temp/3.5 | ||
| - release/3.4 |
There was a problem hiding this comment.
Ruby 3.4 has just gone EOL
RichardSmedley
left a comment
RichardSmedley
left a comment
There was a problem hiding this comment.
The bits that relate to SDKs look fine - as to the rest of it, I think it's okay, but I wouldn't count my opinion as a proper review.
If it's been tested, and works well, then 👍
Rationale: as well as the staging playbook, we now have to manage:
All of which need to be kept in sync with the main playbook, preserving just important differences.
As the staging playbook is the most high-profile one with likely the most complexity in setting it up, I'm starting with that, to check that we can do this fully enough to support the requirement.
(The preview one is currently supported by the more straight-forward scripts/patch-preview-playbook, but could use the same code.)