-
Notifications
You must be signed in to change notification settings - Fork 154
chore(ci): automatically update docs after layer publish during release #1324
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
chore(ci): automatically update docs after layer publish during release #1324
Conversation
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.
Looking good, thanks for the work on this and for also talking with the guys over at Python (thanks Ruben if you're reading!).
I've left a few comments here & there but very nice
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.
Thanks for addressing the comments, feel free to merge it when you're ready
Description of your changes
After back and forth and few clarifications with @rubenfonseca about the python setup I have reworked the workflows to their approach.
First, I have removed implicit trigger after the workflow, to have a more explicit control about the flow. We auto update the docs when we publish new layer, which is always during the release, or manual layer release trigger. Because of the second case, we add doc update step to the layer release workflow (rebuild and publish layer -> new doc update). Since we release new layer during release, we can delegate this task to layer workflow.
After some back and forth and more study of the workflow I have restructured the setup. Let's take a look at different cases.
on_doc_merge.yml
I have removed the logic within the reusable workflow for docs, so it now takes input from the caller. This means that either
on_doc_merge
orpublish_layer
will know what version and alias they have to build the docs. This will also remove the failed workflows on forks and pre release doc updates.How to verify this change
Related issues, RFCs
Issue number: #1124
PR status
Is this ready for review?: NO
Is it a breaking change?: NO
Checklist
Breaking change checklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.