Skip to content

Only build docs when docs files changed#198

Merged
yaswant merged 5 commits intoMetOffice:mainfrom
andrewcoughtrie:docs_ci
Jan 30, 2026
Merged

Only build docs when docs files changed#198
yaswant merged 5 commits intoMetOffice:mainfrom
andrewcoughtrie:docs_ci

Conversation

@andrewcoughtrie
Copy link
Collaborator

@andrewcoughtrie andrewcoughtrie commented Jan 29, 2026

PR Summary

Sci/Tech Reviewer: Not Required
Code Reviewer: @yaswant

This change sets the PR and CI documentation building to only happen when files in the documentation directory are changed or any of the workflow files. I believe leaving the running to happen if ANY of the workflow yaml files are changed is a safer option than trying to specify specific ones.

Code Quality Checklist

  • I have performed a self-review of my own code
  • My code follows the project's style guidelines
  • Comments have been included that aid understanding and enhance the readability of the code
  • My changes generate no new warnings
  • All automated checks in the CI pipeline have completed successfully

Testing

  • I have tested this change locally, using the LFRic Apps rose-stem suite
  • If any tests fail (rose-stem or CI) the reason is understood and acceptable (e.g. kgo changes)
  • I have added tests to cover new functionality as appropriate (e.g. system tests, unit tests, etc.)
  • Any new tests have been assigned an appropriate amount of compute resource and have been allocated to an appropriate testing group (i.e. the developer tests are for jobs which use a small amount of compute resource and complete in a matter of minutes)

trac.log

Security Considerations

  • I have reviewed my changes 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

PSyclone Approval

  • If you have edited any PSyclone-related code (e.g. PSyKAl-lite, Kernel interface, optimisation scripts, LFRic data structure code) then please contact the TCD Team

Sci/Tech Review

  • I understand this area of code and the changes being added
  • The proposed changes correspond to the pull request description
  • Documentation is sufficient (do documentation papers need updating)
  • Sufficient testing has been completed

(Please alert the code reviewer via a tag when you have approved the SR)

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

@andrewcoughtrie andrewcoughtrie added this to the Spring 2026 milestone Jan 29, 2026
@andrewcoughtrie andrewcoughtrie marked this pull request as ready for review January 29, 2026 10:58
@james-bruten-mo
Copy link
Collaborator

Just noting that I think the required workflows will require updating in the ruleset when this goes on

README.md Outdated
# LFRic Apps

[![ci](https://github.com/MetOffice/lfric_apps/actions/workflows/ci.yml/badge.svg)](https://github.com/MetOffice/lfric_apps/actions/workflows/ci.yml)
[![Docs](https://github.com/MetOffice/lfric_apps/actions/workflows/ci_docs.yml/badge.svg)](https://github.com/MetOffice/lfric_apps/actions/workflows/ci_docs.yml)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Wondering whether we need [![Documentation]... here

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That's only Alt text it doesn't actually have any influence on what is displayed, we can have it as what ever we want, it will only ever be displayed if the image fails to render.

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.

Thanks!

@yaswant yaswant merged commit 24188e7 into MetOffice:main Jan 30, 2026
12 checks passed
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.

4 participants