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

Versions of pinax-models should be tagged in GitHub #15

Open
JordanReiter opened this issue Jun 29, 2016 · 3 comments
Open

Versions of pinax-models should be tagged in GitHub #15

JordanReiter opened this issue Jun 29, 2016 · 3 comments

Comments

@JordanReiter
Copy link

JordanReiter commented Jun 29, 2016

The "current" version of pinax-models (e.g. what you get when you use pip install pinax-models) appears to date back to a much earlier version of the code. As such, it would be useful to be able to reference, instead, an updated version of the code in a requirements.txt file.

However, there are currently no tags for the various versions, only the master branch. As a result, it is possible (indeed, I have had it happen for other github repos) that if the master branch of pinax-models were used as a requirement for a deployed server, the server could break the next time it was deployed if there were an error or problem in the source code.

Instead, we should have tagged versions of the code, so that we can indicate which version we want to use when pulling in the code from github.

Also, version numbers should be incremented when significant changes are made to the code. For example, the code for deleting related objects has changed substantially from code for 2.0 but the version number is still 2.0.

@jtauber
Copy link
Member

jtauber commented Jun 29, 2016

One can always use commit SHAs so tags aren't strictly necessary, but agree we need to tag releases (and make sure we do them regularly).

For related reasons, we always recommend pinning requirements (to released versions if possible but to SHAs at the very least, rather than just HEAD)

@JordanReiter
Copy link
Author

For related reasons, we always recommend pinning requirements (to released versions if possible but to SHAs at the very least, rather than just HEAD)

Understood. Note that I believe the released version of pinax-models is faulty when deleting certain records, which is part of the problem.

Also something like
-e git+https://github.com/pinax/[email protected]#…
is so much cleaner and readable than
-e git+https://github.com/pinax/pinax-models.git@19c5031a4586436b9f023183adea2daa#…
It also gives a better hint to the version you want. So if you make a bug fix for a particular version I can tell whether it applies to me or not.

@JordanReiter
Copy link
Author

If you need help with the tagging, let me know. Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants