Skip to content

Commit

Permalink
Docs: update contributing, and fix troubleshooting.
Browse files Browse the repository at this point in the history
  • Loading branch information
itsayellow committed Jan 16, 2021
1 parent ff9b161 commit 83c9961
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 22 deletions.
39 changes: 27 additions & 12 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,20 +127,35 @@ nox -s publish_docs
## Releasing New `pipx` Versions
### Pre-release

* Update pipx's version in `src/pipx/version.py` to the new version
* Make sure the changelog is updated
* Put the version of the new release as the header for the latest block of changes (instead of "dev").
* Make sure all notable changes are listed.
* Regenerate documentation.
First, make sure the changelog is complete. Next decide what the next version
number will be. Then, from a clone of the main pipxproject pipx repo (not a
fork) execute:
```
nox -s pre_release
```

Enter the new version number when asked. When the script is finished, check the
diff it produces. If the diff looks correct, commit the changes as the
script instructs, and push the result.

The script will modify `src/pipx/version.py` to contain the new version, and
also update the changelog (`docs/changelog.md`) to specify the new version.

### Release
To publish to PyPI: From a clone of the main pipxproject pipx repo (not a fork), run
```bash
nox -s publish
To publish to PyPI simply create a "published" release on Github. This will
trigger Github workflows that both publish the pipx version to PyPI and publish
the pipx documentation to the pipx website.

### Post-release
From a clone of the main pipxproject pipx repo (not a
fork) execute:
```
nox -s post_release
```

Additionally, create a new release in GitHub.
When the script is finished, check the diff it produces. If the diff looks
correct, commit the changes as the script instructs, and push the result.

### Post-release
* Update pipx's version in `src/pipx/version.py` by adding a suffix `"dev0"` for unreleased development.
* Update the changelog to start a new section at the top entitled `dev`
This will update pipx's version in `src/pipx/version.py` by adding a suffix
`"dev0"` for unreleased development, and will update the changelog to start a
new section at the top entitled `dev`.
20 changes: 10 additions & 10 deletions docs/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,9 @@ The following command should fix many problems you may encounter as a pipx user:
pipx reinstall-all
```

If your pipx-installed package was installed using a pipx version before
0.15.0.0 and you want to specify particular options, then you may want to
uninstall and install it manually:

```
pipx uninstall <mypackage>
pipx install <mypackage>
```

This is a good fix for the following problems:

* System python was upgraded and the python used with a pipx-package is no longer available
* System python was upgraded and the python used with a pipx-installed package is no longer available
* pipx upgrade causes issues with old pipx-installed packages

pipx has been upgraded a lot over the years. If you are a long-standing pipx
Expand All @@ -26,6 +17,15 @@ have internal data that is different than what pipx currently expects. By
executing `pipx reinstall-all`, pipx will re-write its internal data and this
should fix many of issues you may encounter.

**Note:** If your pipx-installed package was installed using a pipx version
before 0.15.0.0 and you want to specify particular options, then you may want
to uninstall and install it manually:

```
pipx uninstall <mypackage>
pipx install <mypackage>
```

## Diagnosing problems using `list`

```
Expand Down

0 comments on commit 83c9961

Please sign in to comment.