-
Notifications
You must be signed in to change notification settings - Fork 42
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
Move installation instructions #156
Conversation
Codecov Report
@@ Coverage Diff @@
## master #156 +/- ##
=======================================
Coverage 85.09% 85.09%
=======================================
Files 39 39
Lines 1845 1845
=======================================
Hits 1570 1570
Misses 275 275
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this @ml-evs
I am not sure the auto-generating latest
tag is a good idea - or rather, it seems too complicated compared to just have master
be the latest and if one wants a specific version they can install that tagged version?
Or what did you have in mind? :)
Also - are there any changes going from CONTRIBUTING to INSTALL?
README.md
Outdated
|
||
## Installation (Index Meta-Database) | ||
The latest stable version can be obtained from [PyPI](https://pypi.org/project/optimade) `pip install optimade` or by cloning this repository `git clone git@github.com:Materials-Consortia/optimade-python-tools latest`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think there is a need to create the latest
tag - it will naturally be master
, which is also the default branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If that's how we're intending to use master
then that's fine, though major releases will invovle some large PRs... or just using a different branch of course.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah. I think we should use the recommendation that users pin to a specific version, since master
will always be the latest version, and therefore may also introduce backwards-incompatible changes. Right? Or simply use the same dependency scheme we have employed, i.e. optimade~=0.3.3
to keep to the 0.3.x
versions, or optimade~=0.3
to keep to the 0.x
versions. This will of course mean we should keep publishing to PyPI, but I don't see a problem with that?
No changes! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking good for me - thanks @ml-evs !
(I found an extra white-space, I just removed it in the suggested change).
Cheers @CasperWA |
As discussed, closes #136
I've got a "task" working for auto-tagging branches when
invoke setver
is called, though I think this will mess things up as commits inside PRs will be tagged... unless we are very careful with this I think we need a better automated solution (presumably some kind of bot).This does mean that the instructions in this PR are incorrect unless we keep manually moving the
latest
tag to the whatever the current release tag is called.