Skip to content

Commit b31e876

Browse files
committed
Additional updates to release docs
1 parent 187ec57 commit b31e876

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/how-to-release.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# How to release dash-bootstrap-components
22

3-
This is a set of instructions for releasing _dash-bootstrap-components_. The release process is somewhat automated with an [`invoke`](https://docs.pyinvoke.org/en/latest/getting-started.html) task file. You will need `invoke` and `semver` installed.
3+
This is a set of instructions for releasing _dash-bootstrap-components_. The release process is somewhat automated with [`just`](https://github.com/casey/just)
44

5-
- 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 push a release branch to GitHub.
5+
- Run `just 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 push a release branch to GitHub.
66

77
- Create a pull request with this branch, and document changes in the release in the comment of your pull request. The title and comment of the pull request are used by GitHub Actions to make the release on GitHub. See the other releases or the [changelog](https://dash-bootstrap-components.opensource.faculty.ai/changelog/) for previous release summaries.
88

99
- Merge the pull request. This will trigger a GitHub Action that will build the package and upload to PyPI.
1010

11-
- 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.
11+
- Verify that you can install the new version and that it works correctly with `pip install dash-bootstrap-components==<new version>`.
1212

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

15-
- Run `invoke release <version>`, where `version` is the version number of the release (e.g. `0.7.0`). This will push a release branch to GitHub.
15+
- Run `just release <version>`, where `version` is the version number of the release (e.g. `0.0.7`). This will push a release branch to GitHub.
1616

1717
- As before, open a pull request and use the title and comment to document changes to the package. When the pull request is merged GitHub Actions will build the packages and upload it to PyPI.
1818

@@ -23,5 +23,5 @@ This is a set of instructions for releasing _dash-bootstrap-components_. The rel
2323
The documentation is currently hosted on Heroku. To push documentation updates:
2424

2525
```sh
26-
invoke documentation
26+
just deploy-docs
2727
```

0 commit comments

Comments
 (0)