Repository navigation
Add workbook catalog, validation, and scrubbing infrastructure - #1
Merged
Merged
Conversation
- Replace real subscription, resource group and workspace identifiers in 59 workbooks with neutral placeholders; replace two personal e-mail addresses used as parameter defaults with user@example.com - Fix DataConnectorCost.workbook, which began with a // comment and was not valid JSON; the description now lives in its first text step - Add scripts/validate_workbooks.py (JSON validity, Notebook/1.0 shape, leaked resource IDs), scripts/scrub_resource_ids.py and scripts/build_catalog.py, all standard-library Python - Add a GitHub Actions workflow that runs the three checks on every PR - Generate CATALOG.md listing all 824 workbooks with derived titles and top-level parameters so same-named exports can be told apart - Rewrite README (files are .workbook, not .json; category table with counts; import steps; tooling), add CONTRIBUTING.md, .gitattributes (highlight .workbook as JSON) and .editorconfig Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018fsKr7G5DH3d8uyFxBjMnb
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.
This PR establishes a comprehensive infrastructure for managing and validating the workbook template repository, including automated catalog generation, resource ID scrubbing, and CI/CD validation.
Summary
Adds tooling and documentation to improve the repository's usability and maintainability:
Key Changes
New Scripts:
scripts/build_catalog.py- GeneratesCATALOG.mdwith workbook titles (derived from content), parameters, and step countsscripts/validate_workbooks.py- Validates JSON structure, version compatibility, and checks for leaked resource IDsscripts/scrub_resource_ids.py- Replaces environment-specific Azure resource paths with neutral placeholders (subscription GUIDs, resource group names, workspace names)Documentation:
CATALOG.md- Auto-generated index of all workbooks with derived titles and metadataCONTRIBUTING.md- Guidelines for adding new workbooks, including the scrubbing workflowREADME.md- Reorganized with category table and link to catalogConfiguration:
.github/workflows/validate.yml- CI gate that validates workbooks and checks for stale catalog/placeholders.editorconfig- Standardizes formatting (UTF-8, LF line endings, 2-space JSON indent).gitattributes- Configures GitHub to treat.workbookfiles as JSON for syntax highlightingWorkbook Updates:
scrub_resource_ids.pyto 40+ workbooks to replace leaked subscription IDs, resource groups, and workspace names with placeholdersDataConnectorCost.workbook)Implementation Details
/subscriptions/<guid>/...) and URL-encoded (%2Fsubscriptions%2F...) forms"version": "Notebook/1.0"and presence ofitemsarray as minimum requirements--checkmode for CI integration without modifying fileshttps://claude.ai/code/session_018fsKr7G5DH3d8uyFxBjMnb