OpenFn / OpenFn/kit

CLI: support channels in v2 deploy

Open
#1,522 1 comment 0 reactions 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

A v2 project currently gives users no way to add, remove or modify channels configiration.

We should consider:

  • Maybe add channels to openfn.yaml, as we did with collections
  • Maybe add a channels.yaml file to hold yaml configuration for the project

channels.yaml feels better because channels have a bunch of configuration. It's not so nice to have that compressed into openfn.yaml. Better to surface it. There's a bit of precedence as well with the credentials.yaml file.

Warning from claude, which thinks it's found a bug: during sandbox merges (or at least, a projecet merge with mode sandbox), channels data is dropped. Something to do with the spread on merge.

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 by tracing the v2 deploy configuration flow and the sandbox project merge, then compare how openfn.yaml and credentials.yaml are handled. Decide where channel configuration belongs, implement support for adding, removing, and modifying channels, and verify that channel data is preserved during sandbox merges.

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
Active
Clarity
Needs clarification
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.