add um_utils docs#17
Conversation
There was a problem hiding this comment.
James Bruten (@james-bruten-mo)
The artifact is still uploaded from ./mule/docs/build/html so I am not sure how that would work! You probably forgot to replace ./mule/docs/build/html with .github/files in the upload-pages-artifact step?
we need to upload:
somewhere (we have the built docs for both mule and um_utils that will be uploaded)
├── index.html
├── mule
└── um_utils
Thanks Yash - might have made more sense if I'd remembered to update the artifact upload path! But agree we don't need to store the index.html file, so updated that |
Yaswant Pradhan (yaswant)
left a comment
There was a problem hiding this comment.
Looks good.
PR Summary
Code Reviewer: Yaswant Pradhan (@yaswant)
It's been pointed out that the um_utils docs aren't included in the gh-pages deployment. They're built by the workflow but not deployed. This corrects that.
It also changes the workflow to only upload the artifact if this is a push to main.
Code Quality Checklist
(Some checks are automatically carried out via the CI pipeline)
readability of the code
Testing
acceptable (eg. kgo changes)
tests, unit tests, etc.)
trac.log
Security Considerations
Performance Impact
performance measurements have been conducted
AI Assistance and Attribution
of Generative AI tool name (e.g., Met Office Github Copilot Enterprise,
Github Copilot Personal, ChatGPT GPT-4, etc) and I have followed the
Simulation Systems AI policy
(including attribution labels)
Documentation
confirmed that it builds correctly
Code Review