OpenFn / OpenFn/kit

Make sure that v2 project yaml is supported by v2 deploy

Open
#1,421 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

Make sure that the v2 deploy function works well from a single spec file

So rather than deploying what's expanded on the filesystem, we can deploy from a single spec file.

If the repo already has a project state yaml file, it should use this to find the endpoint and stuff. I guess precedence is:

  • accept endpoint and project id from args
  • load endpoint and project id from alias or UUID (works if this isn't the first deploy)
  • load endpoint and project id from openfn.yaml (maybe? feels a bit loose?)
  • accept endpoint and project id from env

v1 deploy should not work with the v2 format. We should probably add a nice error

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.

Research direction

Start at the v2 deploy function and inspect how it currently uses the expanded filesystem, then review the project state YAML and openfn.yaml paths mentioned in the issue. Done means v2 deploy can resolve endpoint and project ID from the stated precedence sources, while v1 deploy rejects the v2 format with a clear error.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.