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.

Sign up for GitHub

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

Jump to bottom

Add versions, tags & --version cmd #146

Closed
jameshadfield opened this issue Jul 2, 2018 · 3 comments
Closed

Add versions, tags & --version cmd #146

jameshadfield opened this issue Jul 2, 2018 · 3 comments
Assignees
@tsibley

Comments

@jameshadfield
Copy link
Member

As we move builds into separate repositories, augur versioning becomes important. I imagine:

  • https://stackoverflow.com/a/7071358 seems to imply this should be in _version.py
  • Does every push to master bump up the version?
  • We should tag each version so that it's easy to checkout certain versions
  • augur --version should print the version
  • a changelog would also be a good idea at this point
  • I think we start from 3.0.0
@jameshadfield jameshadfield mentioned this issue Jul 2, 2018
Closed
@tsibley
Copy link
Member

tsibley commented Jul 2, 2018

I would recommend (naturally) the approach I took in https://github.com/nextstrain/cli:

  • an augur/__version__.py that's simple enough to be statically parsed (for release management tooling)
  • …but that can still be used to import a __version__ variable at runtime (for a --version option or version subcommand to use).
  • setup.py then gets a snippet to read that file.

Does every push to master bump up the version?

No. The version should be managed manually and follow semantic versioning rules. Releases are things you version, not commits.

We should tag each version so that it's easy to checkout certain versions

Yes, totally. Here's what I did for nextstrain-cli: https://github.com/nextstrain/cli/blob/master/devel/release

augur --version should print the version

Yep, or augur version.

a changelog would also be a good idea at this point

Yes!

I think we start from 3.0.0

Sure.

@trvrb
Copy link
Member

trvrb commented Jul 3, 2018

I endorse all of this.

@jameshadfield jameshadfield mentioned this issue Aug 17, 2018
Closed
@tsibley tsibley self-assigned this Aug 17, 2018
tsibley added a commit that referenced this issue Aug 31, 2018
@tsibley
Add release tooling
ade7d87 
The devel/release script sanity checks state of the repo and change log,
bumps the version, makes a commit and tags it, merges into the "release"
branch, and ends with instructions on how to push.  It is based on the
very similar script I wrote for nextstrain-cli, with the "release"
branch behaviour adopted from auspice.

Resolves #202 and #146.
@tsibley tsibley mentioned this issue Aug 31, 2018
Merged
6 tasks
@tsibley
Copy link
Member

tsibley commented Sep 6, 2018

There's one bit of this that wasn't resolved by #210: a --version flag as an alias for augur version. I'll do that soon.

tsibley added a commit that referenced this issue Sep 6, 2018
@tsibley
Alias "augur --version" to "augur version"
6b8272f 
It's not uncommon to blindly run a command with --version as the sole
argument, so its useful to make that Just Work.

Resolves the final bit of #146.
@tsibley tsibley mentioned this issue Sep 6, 2018
Merged
tsibley added a commit that referenced this issue Sep 20, 2018
@tsibley
Alias "augur --version" to "augur version"
c9ac5f0 
It's not uncommon to blindly run a command with --version as the sole
argument, so its useful to make that Just Work.

Resolves the final bit of #146.
@tsibley tsibley closed this as completed Nov 15, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tsibley tsibley

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@tsibley @trvrb @jameshadfield