OpenFn / OpenFn/lightning

Allow users to specify if they want relative paths when pulling from OpenFn

Open
#2,505 1 comment 0 reactions 1 assignee View on GitHub

@josephjclark is already working on this.

Since Apr 29, 2025.

ux/ui improvement
Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

OpenFn gives users the flexibility to reference job code using relative paths in the project spec.yaml or to write the job code inline in the body section of the Spec. This preference is preserved when a user updates a local/GH version of their Spec by running the CLI pull command but if there are new jobs/workflows, the code will be written inline.

It would be great to allow users to specify if they want their project.yaml to adopt a relative path approach, this way, we can export the jobs in a workflows/workflow_name directory keeping all the jobs associated with each workflow in the project.

We have seen situation where a project.yaml file adopts both systems (inline and relative path) and the user feels like some job code files are missing or weren't synced. Users should be able to specify if they want job code inline to relative.

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.