Omnibus 2024-11-27

[maddenp-noaa]

Synopsis

• Update .github such that the Test workflow will be run for PRs or pushes to all branches. This means that tests will run for updates on release branches, which seems like it would have been a good idea to always be doing.
• Add setuptools to conda build requirements, as it appears not to be automatically installed with Python 3.13 now in CI jobs, but is required for the uwtools build.
• Some updated documentation about the !include tag.
• Some trivial doc changes per make docs.
• Fix a bug whereby Jinja2 expressions referencing tagged YAML values would render to strings including the tag as part of the string. The fix involves detecting tagged values and raising an exception to delay rendering the value until a later iteration of the dereferencing process, when the tagged value will have been converted to its simple type (int, bool, etc.). See below (and the new unit tests) for examples.

Given config.yaml

a: 2
b: 7
foo: !int "{{ a * b }}"
bar: !int "{{ foo }}"

Old behavior:

$ uw config realize -i config.yaml --output-format yaml
a: 2
b: 7
foo: 14
bar: !int '!int 14'

New behavior:

$ uw config realize -i config.yaml --output-format yaml
a: 2
b: 7
foo: 14
bar: 14

Type

• Bug fix (corrects a known issue)
• Documentation
• Tooling (CI, code-quality, packaging, revision-control, etc.)

Impact

• This is a non-breaking change (existing functionality continues to work as expected)

Checklist

• I have added myself and any co-authors to the PR's Assignees list.
• I have reviewed the documentation and have made any updates necessitated by this change.

[christinaholtNOAA]

LGTM. This makes for a much cleaner user experience than my workaround.

Maybe a small docs change is needed?