Skip to content

Versioning for Ruth and Roth #32

@seriesumei

Description

@seriesumei

We have an interesting situation in the name of this project containing what looks like a version string: Ruth 2.0. Historically the releases have been labelled RC1, etc, which implies not having an actual release, which is probably accurate, they were more like checkpoints really.

I am proposing here a naming convention for release versions that I hope is not too different from what folks are used to seeing but gets specific and hopefully prevents some confusion from happening.

  • The project name is colloquially Ruth 2.0, with Roth 2.0 coming later. This Github project name fortunately does not have the numbers in it but there is some value in keeping the name, so let's do that (unless there are strong feelings here I have not heard about yet). We should try to not use the words version or release in connection with the 2.0 in the project name.

  • Ruth: We have generally agreed that the current work on Ruth is going to be called 4-something. Previously there were RC2 and RC3 so 4 is natural to follow. I propose to stop using the letters 'RC' since that means Release Candidate to most people and we are really talking about a release or version identifier. I would suggest instead talking about 'release 4' or 'version 4' with my personal preference for using 'version' because of the tendency to abbreviate it as 'v4'. Using 'r4' or 'R4' looks a lot like 'RC4', although that may actually be a benefit. Thoughts?

  • Roth: Basically the same discussion as above, we should use the same process, only the current work is for v2. This should be the only time we will have Roth 2.0 v2 or something that looks redundant.

  • Internal references: For things like file names, git tags or branch names I propose that we simply leave out the '2.0' everywhere. A tag for the next Roth release might look like 'Roth-v2'.

I am interested to hear what folks think. I am thinking about this from a software developers point of view, does it make sense to others too? If not, how can it be improved?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions