Add doc automation workflows and enhance pr-review#56
Closed
Conversation
- publish-docs.yaml: scaffolded reusable workflow for publishing connector docs to registry on release (blocked by registry deployment) - sync-stable-docs.yaml: scaffolded reusable workflow for syncing stable channel docs from registry to ConductorOne/docs - release.yaml: add commented publish-docs job block - pr-review skill: add Step 5 for auto-updating AUTO-GENERATED sections in docs/connector.mdx when docs-reviewer detects staleness - pr-review.yaml: contents: write permission, expanded allowed tools for doc auto-update capability
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Assume PR won't merge until registry is live. Removed commented-out patterns from publish-docs, sync-stable-docs, and release.yaml. Kept TODO comments for registry endpoint configuration.
Doc freshness enforcement moves to CI check (check-doc-freshness job in generate-baton-metadata) instead of agent-push. This avoids git history pollution and keeps the pr-review agent read-only.
Moved to baton-admin where it runs as a cron job using the existing baton-admin GitHub App for cross-repo commits to ConductorOne/docs.
Contributor
Author
|
Closing — doc publishing happens via the existing record-connector-registry step in release.yaml (RecordReleaseRequest already has a documentation field). No separate publish-docs workflow needed. |
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
1 participant
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
Adds infrastructure for automated connector documentation as part of the automate-connector-docs project.
docs/connector.mdxto the connector registry on release. Blocked by registry deployment — active logic is behind TODOs.publish-docsjob block, ready to activate when registry is deployed.AUTO-GENERATEDsections indocs/connector.mdx. Commits and pushes the changes to the PR branch.contents: writepermission and expanded allowed tools to support doc auto-updates.Why
Connector docs drift silently from code changes today. This enables the pr-review agent to automatically keep auto-generated doc sections (capabilities table, config params) in sync with the connector's actual metadata during PRs.
Test plan
actor manual review)