Skip to content

Commit 373d964

Browse files
authored
Merge pull request #504 from imrehg/rst-to-md
docs: update the "how to release" markdown file away from its rst origns
2 parents 7cf4316 + a7aa460 commit 373d964

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/how-to-release.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11

22
# How to release dash-bootstrap-components
33

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.
55

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.
77

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.
99

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.
1111

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.
1313

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.
1515

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.
1717

1818
# Releasing documentation changes
1919

2020
The documentation is currently hosted on Heroku. To push documentation updates:
2121

22-
```
22+
```sh
2323
git remote add heroku https://git.heroku.com/dash-bootstrap-components.git
2424
git subtree push --prefix docs/ heroku master
2525
```

0 commit comments

Comments
 (0)