Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change version to 0.1.0.beta2 #50

Merged
merged 2 commits into from
Sep 13, 2023

Conversation

benjaminoakes
Copy link
Contributor

@benjaminoakes benjaminoakes commented Sep 12, 2023

Overview

This change changes from the version from 1.0.0.beta1 to 0.1.0.beta2. (There was previously a 0.1.0.beta1.) Normally, rolling back the version would not make sense. However, in this case, it seems warranted. Please see below.

Rationale

  • Currently, SuperSpreader has not been released publicly and no production code is actively using it. (While we have used SuperSpreader in production, it's always been on a one-off basis while a backfill is running.)
  • While we have tested SuperSpreader in production, it's only been a pre-release version (1.0.0.beta1). This should not prevent releasing a true 1.0.0 later.
  • Our version naming convention for Doximity gems has been to start at v0, and indeed many (if not all) of our open-source Ruby gems are v0.x.
  • We currently have this disclaimer in the README, which feels out of place with a 1.0 release

Please be aware: SuperSpreader is still fairly early in development. While it can be used effectively by experienced hands, we are aware that it could have a better developer experience (DevX). It was written to solve a specific problem (see "History"). We are working to generalize the tool as the need arises. Pull requests are welcome!

  • Personally, I would like this feature noted in the README to be added prior to 1.0:

Important: SuperSpreader currently only supports a single configuration, though removing that limitation is our Roadmap (please see below).

Counterpoints

Semver states:

How do I know when to release 1.0.0?

If your software is being used in production, it should probably already be 1.0.0. If you have a stable API on which users have come to depend, you should be 1.0.0. If you’re worrying a lot about backward compatibility, you should probably already be 1.0.0.

We have been using SuperSpreader in production and we care about these concerns, but the other reasoning would seem to outweigh this.

@benjaminoakes benjaminoakes added this to the 1: Version 0.1 milestone Sep 12, 2023
@benjaminoakes benjaminoakes merged commit 9c438a0 into master Sep 13, 2023
@benjaminoakes benjaminoakes deleted the benjaminoakes/change-version-to-0.1.0.beta2 branch September 13, 2023 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants