usnews/smoketest

Create version Git tags; consider GitHub releases

mcbridem opened this issue · 1 comments

Now that we've published Smoketest on GitHub and we're making improvements to it (e.g., a level tokenization feature added in #3), we should create version Git tags for the Smoketest code repository. I think to start we should have a v1.0.0 Git tag that's a pointer to de5f7a4.

We should update the version string in setup.py appropriately in the latest code:

'version': '1.0.0',

After doing so, I think we should create another Git tag for v1.0.1 or v1.1.0 or v2.0.0 or similar, matching setup.py's version string.

GitHub has a releases feature that seems to use Git tags, but in a slightly augmented way. Documentation is here: https://help.github.com/articles/about-releases/. We should consider GitHub releases as well.

Doing some GitHub releases may make sense but I'm not sure they should be done pro-actively before someone needs them. Annotated tags may function fine for now given how most people (who?) would use smoketest.

I think a three-dot version for smoketest is kind of too granular for this. I think Major.Minor where incrementing Major means a significant breakage to reading of settings or expectations. Very minor changes that won't cause incorrect results probably don't need a major version bump.

So make v1.0 for the initial version released on Github and then maybe update setup.py/tag whatever commit smoketest is at with v1.1/'1.1' and go from there?