OpenFn / OpenFn/apollo

Start versioning individual services?

Open
#556 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
5
Forks
10
Avg merge
2d 20h
Merged PRs (30d)
17

Description

Apollo currently uses a single version number for the server and all its services.

It might be nicer and cleaner for each servivce to maintain its own verrsion, and the an overall version for the server. This would allow us to make breaking changes on one service without producing an overall breaking change on the server..

I think a bit about the googleapis library with this stuff. The googleaps package contains SDKs for every Google service. And every time a service breaks its API (quite common), the whole package gets bumped up a major. So when you're using googleapis v50, and latest is v100, and the only API you use is googlesheets - you have to check over 50 versions to workout if there's a relevant breaking change. It's madness. So I'd like to avoid that.

Contributor guide

Open the contributing guide

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

No files, tests, or entry points are identified in the issue. First map how Apollo currently stores and publishes the server and service version, then define the desired per-service and overall-version rules and the checks that would demonstrate the change is complete.

Written by the indexing model from the issue text.

Assessment

Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.