Skip to content

Pass environment variable $fre_yaml to plugin scripts that points to yaml#230

Open
ceblanton wants to merge 3 commits intoNOAA-GFDL:mainfrom
ceblanton:223.pass-yaml-filepath-to-plugin-scripts
Open

Pass environment variable $fre_yaml to plugin scripts that points to yaml#230
ceblanton wants to merge 3 commits intoNOAA-GFDL:mainfrom
ceblanton:223.pass-yaml-filepath-to-plugin-scripts

Conversation

@ceblanton
Copy link
Copy Markdown
Contributor

@ceblanton ceblanton commented Apr 14, 2026

Describe your changes

Issue ticket number and link (if applicable)

#223

Checklist before requesting a review

  • I ran my code
  • I tried to make my code readable
  • I tried to comment my code
  • I wrote a new test, if applicable
  • I wrote new instructions/documentation, if applicable
  • I ran pytest and inspected it's output
  • I ran pylint and attempted to implement some of it's feedback
  • No print statements; all user-facing info uses logging module

Manual Pipeline Run Details

Was the manual pipeline (test_cloud_runner) triggered for this PR?

  • Yes
  • No

Result of manual pipeline run:

(Paste relevant logs, output, or a link to the workflow run here)

How to trigger the manual pipeline:

The test_cloud_runner pipeline is not automatically associated as a required check with the PR; it must be triggered to test changes in a full post-processing run.

To trigger the manual pipeline:

  1. Follow the link to the test_cloud_runner actions tab here

    • you should see "This workflow has a workflow_dispatch event trigger"
  2. Click the dropdown "Run workflow":

    a. If trying to merge from a branch on fre-workflows: choose branch from the first drop down, leave the next 2 inputs blank, and choose the fre-cli branch to test

    b. If trying to merge from a fre-workflows fork: can skip first branch selection, input the fork name (ex: [user]/fre-workflows), input the fork's branch name, and choose the fre-cli branch to test

  3. Click "Run workflow"

Note: you may need to reload the page to see your running workflow.

@ceblanton ceblanton requested review from ilaflott and singhd789 April 14, 2026 19:48
@ceblanton ceblanton changed the title Pass environment variable $yaml to plugin scripts that points to yaml Pass environment variable $fre_yaml to plugin scripts that points to yaml Apr 14, 2026
@ilaflott ilaflott requested a review from Copilot April 14, 2026 22:41
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR makes the combined experiment YAML path available to all Cylc tasks (and therefore plugin scripts) via a single inherited environment variable, addressing the need for preanalysis scripts to locate and parse the YAML configuration.

Changes:

  • Define fre_yaml once at [runtime][[root]][[[environment]]] as $CYLC_WORKFLOW_RUN_DIR/{{ YAML }}.
  • Remove per-task yaml_config environment definitions and switch callers to use $fre_yaml.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants