Pipx metadata changelog #289
Conversation
|
btw I just noticed that commit 8011c12 "null out pythonpath" changed the version number in |
There was a problem hiding this comment.
After thinking about this a little, I should have requested changes on that PR and not let the version change. Here is my reasoning.
The version number in the README and in the docs should reflect the latest version published on PyPI. In this case that is still 0.14.0.0.
README.md and templates/index.md are both generated from generate_docs.py, which uses the version number in main.py. Therefore, the version in main.py should remain the same until a new version is published to PyPI.
To keep things clear to developers, git hashes are tagged with version numbers when a PyPI version is published. At the time of release, a new version number needs to be chosen. pipx follows semantic versioning, which you should read up on if you are not familiar.
The person managing the release (still me for now, but that will change at some point) will have to know what type of release is being created: major, minor, or patch. This will likely be done by reading over CHANGELOG.md or just asking in the pipx maintainers discussion group.
The next release will definitely be a major release due to all the CLI API changes, but the version should still stay the same for now, until the changes are published to PyPI.
docs/changelog.md
Outdated
| - Now store metadata information for each application installed, including install options like `--spec`, and injected packages. This information allows upgrade, upgrade-all and reinstall-all to work properly even with non-pypi installed packages. (#222) | ||
| - Change `upgrade`, removing options `--spec`, `--include-deps`. Use original options used to install application instead. (#222) | ||
| - Change `upgrade-all`, removing options `--include-deps`, `--system-site-packages`, `--index-url`, `--editable`, `--pip-args`. Use original options used to install each application instead. (#222) | ||
| - Change `reinstall-all`, removing options `--include-deps`, `--system-site-packages`, `--index-url`, `--editable`, `--pip-args`. Use original options used to install each application instead. (#222) |
There was a problem hiding this comment.
nit: The way this is phased sometimes comes across like a user has to take action. For example
Now store metadata information
could be written as
Metadata is now stored for each application...
And
Use original options used to install each application instead.
might be more clear as
Original options are used to install each application instead
There was a problem hiding this comment.
Yeah you're right, I was in "git commit" mode when writing these. I'll make them more passive.
There was a problem hiding this comment.
I fixed the ones I added in this PR, but I notice that some of the previous changelog entries sound similarly commanding. I left them be for now.
|
Hmmm after thinking a little more, the README and docs should reflect what is on PyPI, so maybe we shouldn't be generating docs until a new release is published to PyPI. |
|
Looks good other than the version change. It should remain at 0.14.0.0 for now still. |
Right, I forgot to do that. Should be good now, only changelog entries. |
|
Looks good. I was hoping to see the version go back to 0.14.0.0 and corresponding doc changes, but that can be done in another PR. |
Oh I can do that too if you want. I thought you said you were going to request those changes from the PR that changed them. I can definitely change the version back. And fix the docs. |
Extra changelog items and rebuild of docs for PR #222