feat: Add automated permissions docs update workflow #1003
Merged
Conversation
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
Add GitHub Actions workflow and Python script to automatically sync permissions tables from Platform repo to docs when grants files are updated. The workflow: - Triggers on repository_dispatch from Platform repo - Parses tables from Platform's grants_roles.md and grants_operations.md - Updates corresponding tables in platform-cloud and platform-enterprise_docs - Creates draft PR with changes for review - Generates error report if any updates fail Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
❌ Deploy Preview for seqera-docs failed. Why did it fail? →
|
Contributor
Author
|
The workflow triggered successfully on push with the expected failure result since no Platform repo MD files were present. https://github.com/seqeralabs/docs/actions/runs/20845114947/job/59886847740 |
justinegeffen
approved these changes
Jan 12, 2026
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.
Summary
This PR adds automated synchronization of permissions documentation from the Platform repository to the docs repository.
What's New
GitHub Actions Workflow
.github/workflows/update-permissions-docs.ymlrepository_dispatchevents from Platform repodocs/grants_roles.mdordocs/grants_operations.mdare updatedworkflow_dispatchfor testingPython Script
.github/scripts/update-permissions-tables.pygrants_roles.md→roles.md(Role permissions table)grants_operations.md→custom-roles.md(Operations tables by section)UPDATE_ERRORS.mdif any updates failUpdated Files
The workflow automatically updates:
platform-cloud/docs/orgs-and-teams/roles.mdplatform-enterprise_docs/orgs-and-teams/roles.mdplatform-enterprise_docs/orgs-and-teams/custom-roles.mdHow It Works
repository_dispatchevent to docs repoError Handling
Testing
Tested locally with mock Platform and docs repos. All table parsing and updates work correctly.
Related
This workflow pattern is similar to the existing
generate-openapi-overlays.ymlworkflow.🤖 Generated with Claude Code