Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
jaraco committed Aug 24, 2019
2 parents b9e783f + 4baec89 commit e7cac6b
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 12 deletions.
5 changes: 0 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,6 @@ jobs:
if: tag IS present
python: *latest_py3
before_script: skip
env:
- TWINE_USERNAME=jaraco
# TWINE_PASSWORD
- secure: K4MiKMo4GKJIfvEdZYEplypr0F/7qwpOO7nQLJGtQ1qt6SL10e772MzFtiLBPYPZNnBz+aHoSmwwLTDmMOV2S4SgCDwBDT6pz0DY3Ajfs2suLdL0DXM4SeMR8f+apDwcs3SWz1xf1KmzVp2pbSXsTty2QSRBO1/S7ZQo11HsZW8ziGOasxkfogLwbsgH9qdM6UIwPBCpLhmY8HE08dM1sl2YYltC/zv31mTkSi9eV/t15fDXUL6YQTFcrTCKJt/H2X0JYyDUmXEAE6uPuLLHePvqSu2+8FrOsk9w6/lWyB4+L8334d2JV3diygdmSAdMVmQeJqnJas+En30VNVBfXDmNucUZIDN7uqu30f9/b1Yr0dTOPDWLxxF5YojzUvwDAAvT4EUaYW9f/oSDC4Qm8emGhSj2VKJu+bsu0zF+MSHzTtRnsr9MTdbBAS2UA2AVnmW3V6iHlGeWxtVRTT1fvc9Pcjx4P/VzsKokEhh/hONVd62XXor9xzYWgk1wh8I4ylyie4Do2JM3YHc17pKrX9DRzDCef+qlj3qynbg1fMFU4IUefZQodhpnVdPaGSFJ1gEMdeF8DM73DiV/B+GwJ4+gd/IB2bBHA0bm6pe4MYY5APjuWmeGYVYmpjfo3B2HPHaV9D0RF8C5NY45aKQplvMCsRLifYM5kUmX+y6lC+E=
- TOX_TESTENV_PASSENV="TWINE_USERNAME TWINE_PASSWORD"
script: tox -e release

cache: pip
Expand Down
22 changes: 15 additions & 7 deletions skeleton.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,13 +103,7 @@ Relies a .flake8 file to correct some default behaviors:

## Continuous Integration

The project is pre-configured to run tests in [Travis-CI](https://travis-ci.org) (.travis.yml). Any new project must be enabled either through their web site or with the `travis enable` command. In addition to running tests, an additional deploy stage is configured to automatically release tagged commits. The username and password for PyPI must be configured for each project using the `travis` command and only after the travis project is created. As releases are cut with [twine](https://pypi.org/project/twine), the two values are supplied through the `TWINE_USERNAME` and `TWINE_PASSWORD`. To configure the latter as a secret, run the following command:

```
echo "TWINE_PASSWORD={password}" | travis encrypt
```

Or disable it in the CI definition and configure it through the web UI.
The project is pre-configured to run tests in [Travis-CI](https://travis-ci.org) (.travis.yml). Any new project must be enabled either through their web site or with the `travis enable` command.

Features include:
- test against Python 2 and 3
Expand All @@ -118,6 +112,14 @@ Features include:

Also provided is a minimal template for running under Appveyor (Windows).

### Continuous Deployments

In addition to running tests, an additional deploy stage is configured to automatically release tagged commits to PyPI using [API tokens](https://pypi.org/help/#apitoken). The release process expects an authorized token to be configured with Travis as the TWINE_PASSWORD environment variable. After the Travis project is created, configure the token through the web UI or with a command like the following (bash syntax):

```
TWINE_PASSWORD={token} travis env copy TWINE_PASSWORD
```

## Building Documentation

Documentation is automatically built by [Read the Docs](https://readthedocs.org) when the project is registered with it, by way of the .readthedocs.yml file. To test the docs build manually, a tox env may be invoked as `tox -e build-docs`. Both techniques rely on the dependencies declared in `setup.cfg/options.extras_require.docs`.
Expand All @@ -127,3 +129,9 @@ In addition to building the sphinx docs scaffolded in `docs/`, the docs build a
## Cutting releases

By default, tagged commits are released through the continuous integration deploy stage.

Releases may also be cut manually by invoking the tox environment `release` with the PyPI token set as the TWINE_PASSWORD:

```
TWINE_PASSWORD={token} tox -e release
```
4 changes: 4 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ deps =
pep517>=0.5
twine>=1.13
path.py
passenv =
TWINE_PASSWORD
setenv =
TWINE_USERNAME = {env:TWINE_USERNAME:__token__}
commands =
python -c "import path; path.Path('dist').rmtree_p()"
python -m pep517.build .
Expand Down

0 comments on commit e7cac6b

Please sign in to comment.