-
Notifications
You must be signed in to change notification settings - Fork 14
update gh workflow to create PR when ai docs are affected #1004
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?
update gh workflow to create PR when ai docs are affected #1004
Conversation
a64db13
to
7841df5
Compare
7841df5
to
3b5f02e
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.
Thank you for this PR, @aswamy!
Since we're aiming to create a pull request now, do you think we should change what triggers this workflow?
If we leave it as is, it seems like a new PR would be created on every commit, including when we merge the data/latest.json PR itself.
Maybe we could set this workflow to be triggered manually instead, or set the revision
value using a different approach to prevent the creation of too many PRs. What do you think?
Wouldn't this only be created if we merge to main? Also this only creates the PR IF it needs to be created since we have the I guess if we forget to merge one, we can see a lot of these PRs pile up 🤔 |
As soon as we merge a PR updating
Am I missing something? @aswamy, please, feel free to proceed with the merge, if you'd like to validate that assumption :) |
TL;DR
Changed the GitHub workflow to create pull requests for AI documentation updates instead of directly pushing to main.
What changed?
update-latest.yml
workflow to create a pull request for changes instead of pushing directly to mainupdate-ai-docs-YYYYMMDD-HHMMSS
)How to test?
ai/liquid.mdc
anddata/latest.json
Example run: https://github.com/Shopify/theme-liquid-docs/actions/runs/16328413540/job/46124461065
⚠️ NOTE: It also contains the file in this PR since it branches off of main. You can ignore this commit in that PR, only see the changes to
Example PR created: #1006
ai/liquid.mdc
anddata/latest.json
Why make this change?
This change improves the workflow by creating pull requests instead of direct commits to main, which: