|
1 | 1 |
|
2 | 2 | # How to release dash-bootstrap-components
|
3 | 3 |
|
4 |
| -This is a set of instructions for releasing to Pypi. The release process is somewhat automated with an `invoke <http://docs.pyinvoke.org/en/latest/getting_started.html>`_ task file. You will need `invoke` and `semver` installed. |
| 4 | +This is a set of instructions for releasing to Pypi. The release process is somewhat automated with an [`invoke`](http://docs.pyinvoke.org/en/latest/getting_started.html>) task file. You will need `invoke` and `semver` installed. |
5 | 5 |
|
6 |
| - - Run ``invoke prerelease <version>``, where ``version`` is the version number of the release candidate. If you are aiming to release version ``0.0.7``, this will be ``0.0.7-rc1``. This will automatically bump the version numbers and upload the release to Pypi. |
| 6 | +- Run `invoke prerelease <version>`, where `version` is the version number of the release candidate. If you are aiming to release version `0.0.7`, this will be `0.0.7-rc1`. This will automatically bump the version numbers and upload the release to Pypi. |
7 | 7 |
|
8 |
| - - Verify that you can install the new version and that it works correctly with ``pip install dash-bootstrap-components==<new version>``. It's best to verify the installation on a clean virtual machine (rather than just in a new environment) since installation is more complex than for pure Python packages. |
| 8 | +- Verify that you can install the new version and that it works correctly with `pip install dash-bootstrap-components==<new version>`. It's best to verify the installation on a clean virtual machine (rather than just in a new environment) since installation is more complex than for pure Python packages. |
9 | 9 |
|
10 |
| - - If the manual installation tests failed, fix the issue and repeat the previous steps with ``rc2`` etc. If installing worked, proceed to the next steps. |
| 10 | +- If the manual installation tests failed, fix the issue and repeat the previous steps with `rc2` etc. If installing worked, proceed to the next steps. |
11 | 11 |
|
12 |
| - - Run ``invoke release <version>``, where ``version`` is the version number of the release (e.g. ``0.7.0``). You will be prompted to enter a changelog. This will create a release, push it to Pypi and add a tag on current master. |
| 12 | +- Run `invoke release <version>`, where `version` is the version number of the release (e.g. `0.7.0`). You will be prompted to enter a changelog. This will create a release, push it to Pypi and add a tag on current master. |
13 | 13 |
|
14 |
| - - Verify that the new version is available by running ``pip install dash-bootstrap-components`` in a new virtual environment. |
| 14 | +- Verify that the new version is available by running `pip install dash-bootstrap-components` in a new virtual environment. |
15 | 15 |
|
16 |
| - - Run ``invoke postrelease <version>``, where ``version`` is the version number of the new release. This will change the version numbers back to a `-dev` version. |
| 16 | +- Run `invoke postrelease <version>`, where `version` is the version number of the new release. This will change the version numbers back to a `-dev` version. |
17 | 17 |
|
18 | 18 | # Releasing documentation changes
|
19 | 19 |
|
20 | 20 | The documentation is currently hosted on Heroku. To push documentation updates:
|
21 | 21 |
|
22 |
| -``` |
| 22 | +```sh |
23 | 23 | git remote add heroku https://git.heroku.com/dash-bootstrap-components.git
|
24 | 24 | git subtree push --prefix docs/ heroku master
|
25 | 25 | ```
|
0 commit comments