OpenFn / OpenFn/adaptors

Are config-schema changes breaking?

Open
#523 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

question
Dominant language
JavaScript
Stars
24
Forks
41
Avg merge
3d 13h
Merged PRs (30d)
12

Description

This issue is to discuss whether a change to the configuration schema of an adaptor should result in a major release bump.

Because I still don't know and I think we should have a clear policy for this going forward.

Arguments for:

  • A job written for one version may break in another version. I mean it is a breaking change.

Arguments against:

  • You're only breaking the credential, not the job. It's not a breaking change.
  • Job code is actually unaffected
  • It's annoying to bump the major for what is often a trivial change

Perhaps this debate could be mitigated by some means in Lightning to a) bind a credential to an adaptor version, and b) detect conflicts should the adaptor version change.

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 reviewing the existing adaptor configuration-schema and release/versioning policy; the issue names no files, tests, or entry points. Determine a clear policy for whether schema changes require a major release, and define how credential-to-adaptor-version binding or conflict detection should be handled.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
release
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.