feat: add docs-alignment-review workflow - #63
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 adds a new Copilot Coding Agent workflow (
docs-alignment-review) to thepfe-docscollection under theplatform-engineeringgroup.How to use the workflow
Invoke using the
/docs-alignment-reviewcommand in a pull request comment.What the workflow does
The workflow analyzes code changes for end-user impact (config changes, new actions, relation changes, behavioral changes, deployment changes) and determines whether corresponding documentation updates are present. It will fail the check if documentation is needed but missing, or leave a comment if documentation is present but incomplete.
A
skip-docs-checklabel can be applied to bypass the analysis or explicitly record a decision to exclude documentation.This workflow has not been deeply tested yet.
The workflow has been built with charm repositories in mind. Further development is required to generalize the workflow for non-charming repositories.