Skip to content

Commit

Permalink
ci: Add distribution to TestPyPI (#34)
Browse files Browse the repository at this point in the history
* Add publishing to TestPyPI on PR merge using the PyPA publishing GitHub Action
   - c.f. https://github.com/pypa/gh-action-pypi-publish
* Direct users to use TestPyPI install until PyPI namespace is acquired
  • Loading branch information
matthewfeickert authored Sep 23, 2020
1 parent bf95550 commit 2c99516
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/publish-package.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,10 @@ jobs:
echo "python-build named built distribution: ${wheel_name}"
- name: Verify the distribution
run: twine check dist/*
- name: Publish distribution 📦 to Test PyPI
# every PR will trigger a push event on master, so check the push event is actually coming from master
if: github.event_name == 'push' && github.ref == 'refs/heads/master' && github.repository == 'dguest/pandamonium'
uses: pypa/gh-action-pypi-publish@v1.3.1
with:
password: ${{ secrets.test_pypi_password }}
repository_url: https://test.pypi.org/legacy/
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ This tells you if your jobs are done. And stuff like that.

## Installation

### Install from PyPI
### Install from TestPyPI

You can install [`pandamonium` from PyPI][pandamonium_PyPI] into any Python
You can install [`pandamonium` from TestPyPI][pandamonium_TestPyPI] into any Python
virtual environment by simply running

```
python -m pip install pandamonium
python -m pip install panda-client # Needed as panda-client isn't on TestPyPI
python -m pip install -i https://test.pypi.org/simple/ --pre pandamonium
```

### Install the old style of global scripts
Expand All @@ -44,6 +45,7 @@ if [ -d "your/path/stuff/goes/here/pandamonium" ]; then
fi
```

[pandamonium_TestPyPI]: https://test.pypi.org/project/pandamonium/
[pandamonium_PyPI]: https://pypi.org/project/pandamonium/
[tag_v0.1]: https://github.com/dguest/pandamonium/releases/tag/v0.1

Expand Down

0 comments on commit 2c99516

Please sign in to comment.