GithubHelp home page GithubHelp logo

Comments (1)

a-frantz avatar a-frantz commented on September 22, 2024

Choose versioning scheme

My proposal, as loosely inspired by how I've seen many Rust crates organized (like noodles):

  • Repo version + tool versions
    1. Version each file (tool) individually (DO NOT make GitHub releases for each of these updates)
      - scheme: same as our docker tagging system. i.e. we track both the "base tool version" (like STAR v2.7.11b) AND we append our own revision number to it (like -0 or -1). Final product: v2.7.11b-1
    2. Make repo-wide tagged releases ad hoc
      - We start with v1.0.0 to indicate we're "production ready" and most of our updates will either be a "patch" or "bug fix" release that increments the patch num, OR a minor release. I think "breaking changes" would only be defined by some major architectural change and I can't think of an example. But they'd be very rare.

How a user interacts with this: If they are only using a single tool, they could import that specific file, with that <tool version>-<revision number> tag. This is kind of a "mouthful" of a version. I view this as being for advanced users.
If they are using a whole bunch of different tools/files, they would specify a "repo version" which would obfuscate the file-level versions.

How we interact with this: Since we won't be pinging users for every tool revision, we can feel free to update these as often and as trivially as we want. We only ping users when we've made enough changes that we want to notify them. And then we make a repo-wide release.

If a user wants to be on the bleeding edge, they can import everything at the latest file/tool level. However we would recommend most users to use the "convenience" version that packages everything together as a v1.x.x.

from workflows.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.