Skip to content

Comments

add um_utils docs#17

Merged
yaswant merged 4 commits intoMetOffice:mainfrom
james-bruten-mo:um_utils_docs
Feb 16, 2026
Merged

add um_utils docs#17
yaswant merged 4 commits intoMetOffice:mainfrom
james-bruten-mo:um_utils_docs

Conversation

@james-bruten-mo
Copy link
Collaborator

@james-bruten-mo james-bruten-mo commented Feb 13, 2026

PR Summary

Code Reviewer: @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)

  • I have performed a self-review of my own code
  • My code follows the project's style guidelines
  • Comments have been included that aid undertanding and enhance the
    readability of the code
  • My changes generate no new warnings

Testing

  • I have tested this change locally, using the rose-stem suite
  • If any tests fail (rose-stem or CI) the reason is understood and
    acceptable (eg. kgo changes)
  • I have added tests to cover new functionality as appropriate (eg. system
    tests, unit tests, etc.)

trac.log

Security Considerations

  • This change does not introduce security vulnerabilities
  • I have reviewed the code for potential security issues
  • Sensitive data is properly handled (if applicable)
  • Authentication and authorisation are properly implemented (if applicable)

Performance Impact

  • Performance of the code has been considered and, if applicable, suitable
    performance measurements have been conducted

AI Assistance and Attribution

  • Some of the content of this change has been produced with the assistance
    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

  • Where appropriate I have updated documentation related to this change and
    confirmed that it builds correctly

Code Review

  • All dependencies have been resolved
  • Related Issues have been properly linked and addressed
  • CLA compliance has been confirmed
  • Code quality standards have been met
  • Tests are adequate and have passed
  • Documentation is complete and accurate
  • Security considerations have been addressed
  • Performance impact is acceptable

@james-bruten-mo james-bruten-mo marked this pull request as ready for review February 13, 2026 13:58
Copy link
Collaborator

@yaswant yaswant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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

@james-bruten-mo
Copy link
Collaborator Author

@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

Copy link
Collaborator

@yaswant yaswant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.

@yaswant yaswant merged commit 1957b13 into MetOffice:main Feb 16, 2026
14 checks passed
@jennyhickson jennyhickson added this to the Spring 2026 milestone Feb 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants