OpenFn / OpenFn/lightning

New lightning project.yaml variables can break CLI deployment

Open
#3,053 4 comments 0 reactions 1 assignee View on GitHub

@josephjclark is already working on this.

Since Apr 29, 2025.

bug DevX needs technical design
Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

New project-level features add new variables to the project.yaml. When this happens, the CLI must be updated to support the variables so that cli operations can run without breaking. This is a recent report of this bug.

We think fixing this will be expensive but we have a few ideas on how we might pay the debt sustainably.

Potential solutions
  1. Add compatibility to documentation to help users know which cli version is compatible with lightning version.
  2. Update the extraneous parameter error message to suggest updating cli- version.
  3. Add a sentry alert log for extraneous parameter error
  4. Limit the variables exported by project.yaml per time based on CLI compatibility. "don't export concurrency and collections if you are on this CLI version because deploy will break."

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.