-
Notifications
You must be signed in to change notification settings - Fork 313
Create workflow to auto-update MPC user docs #8555
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Create workflow to auto-update MPC user docs #8555
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: enkeefe00 The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
🤖 Gemini AI Assistant AvailableHi @enkeefe00! I'm here to help with your pull request. You can interact with me using the following commands: Available Commands
How to Use
PermissionsOnly OWNER, MEMBER, or COLLABORATOR users can trigger my responses. This ensures secure and appropriate usage. This message was automatically added to help you get started with the Gemini AI assistant. Feel free to delete this comment if you don't need assistance. |
🤖 Hi @enkeefe00, I've received your request, and I'm working on it now! You can track my progress in the logs for more details. |
@gemini-cli /review |
a49a290
to
e16a6fc
Compare
Add a GitHub workflow to create/update an MR for updating the MPC user doc's Available Platform Variants by Cluster table whenever changes to a cluster's MPC host values are detected in a PR. Assisted by: Cursor & Gemini
e16a6fc
to
1750215
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some thoughts, largely looks good to me.
on: | ||
pull_request_target: | ||
paths: | ||
- 'components/multi-platform-controller/**/host-values.yaml' | ||
types: [opened, synchronize, reopened] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What do you think on triggering this workflow on pushes instead of on pull requests? I'm worried about the following sequence of events:
- we open a PR to infra-deployments
- this workflow opens a MR on gitlab
- we merge that MR
- we later decide that the PR is wrong and close it.
This puts our documentation on gitlab out-of-sync with what we have on github and requires manual intervention to cleanup (sure, it's as easy as git revert
, but that's a manual step I'd like to remove from ever happening in the first place).
I'm fine with this PR either way, just food for thought.
|
||
if [ -z "$CHANGED_FILES" ]; then | ||
echo "No MPC host-values.yaml files were changed in this PR" | ||
echo "has_host_values=false" >> $GITHUB_OUTPUT | ||
exit 0 | ||
fi |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since we set the path on the trigger for this PR, this check is redundant.
if [ -z "$CHANGED_FILES" ]; then | |
echo "No MPC host-values.yaml files were changed in this PR" | |
echo "has_host_values=false" >> $GITHUB_OUTPUT | |
exit 0 | |
fi |
Add a GitHub workflow to create/update an MR for updating the MPC user doc's Available Platform Variants by Cluster table whenever changes to a cluster's MPC host config are detected in a PR.
Assisted by: Cursor & Gemini