Skip to content

Add GitHub workflow to make sure history fields docs are up-to-date #4041

@samsrabin

Description

@samsrabin

We have documentation pages for no-FATES and FATES setups that describe all our history outputs. The source files for these are / can be generated by tests (see #2516). It would be great to have a GitHub Workflow that would do very short single-point runs to generate those files, then compare them to the files in doc/source/ and fail on any diffs. This would realistically require the use of a container in which to do the runs, which I'm hoping to make as part of my CIRRUS CI work.

This might also allow us to remove the clm/extra_outputs test referenced in #2516 and then close that issue.

Metadata

Metadata

Assignees

Labels

devopsDevelopment Operations to improve development throughput, E.g., adding GitHub Workflowsdocs-loc:infrastructureRelates to documentation infrastructuredocs-loc:users-guideRelates to User's Guide (using CTSM/tools)docs:infrastructureNew features or bug fixes in the documentation infrastructuredocumentationadditions or edits to user-facing documentation or its infrastructure
No fields configured for Code Health.

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions