Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

xtriggers: reinstate Cylc 7 template variables #4777

Merged
merged 1 commit into from
Mar 31, 2022

Conversation

oliver-sanders
Copy link
Member

@oliver-sanders oliver-sanders commented Mar 25, 2022

  • Closes xtrigger: workflow_name -> workflow #4757
  • Reinstate Cylc 7 xtrigger template variables with deprecation warnings to allow 7/8 compativle xtrigger definitions.
  • Deprecate workflow_name in favor of workflow for consistency with event template variables (and because it's workflow_id not workflow_name).
  • Raise a special xtrigger config exception that inheritc from CylcError rather than primitive exceptions so make errors format more nicely on the CLI.

Requirements check-list

  • I have read CONTRIBUTING.md and added my name as a Code Contributor.
  • Contains logically grouped changes (else tidy your branch by rebase).
  • Does not contain off-topic changes (use other PRs for other changes).
  • Applied any dependency changes to both setup.cfg and conda-environment.yml.
  • Appropriate tests are included (unit and/or functional).
  • Appropriate change log entry included.
  • Docs: xtriggers: autodocument template variables cylc-doc#443

@oliver-sanders oliver-sanders added the bug Something is wrong :( label Mar 25, 2022
@oliver-sanders oliver-sanders added this to the cylc-8.0rc3 milestone Mar 25, 2022
@oliver-sanders oliver-sanders self-assigned this Mar 25, 2022
oliver-sanders added a commit to oliver-sanders/cylc-doc that referenced this pull request Mar 25, 2022
* Closes cylc#4757
* Reinstate Cylc 7 xtrigger template variables with deprecation
  warnings to allow 7/8 compativle xtrigger definitions.
* Deprecate `workflow_name` in favor of `workflow` for consistency with
  event template variables (and because it's `workflow_id` not
  `workflow_name`).
* Raise a special xtrigger config exception that inheritc from CylcError
  rather than primitive exceptions so make errors format more nicely on
  the CLI.
Copy link
Member

@hjoliver hjoliver 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. One question: why retain workflow_name (as well as suite_name) as deprecated?

@oliver-sanders
Copy link
Member Author

One question: why retain workflow_name (as well as suite_name) as deprecated?

I did this because it looks like we have a few RC users out there and didn't want to re-mess-up their workflows.

Copy link
Member

@hjoliver hjoliver left a comment

Choose a reason for hiding this comment

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

Good 👍

Possibly a marginal call, but I reckon one review will do for this.

@hjoliver hjoliver merged commit 14623a4 into cylc:master Mar 31, 2022
@oliver-sanders oliver-sanders deleted the 4757 branch March 31, 2022 09:16
oliver-sanders added a commit to oliver-sanders/cylc-doc that referenced this pull request Apr 6, 2022
wxtim pushed a commit to cylc/cylc-doc that referenced this pull request Apr 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something is wrong :(
Projects
None yet
Development

Successfully merging this pull request may close these issues.

xtrigger: workflow_name -> workflow
2 participants