Skip to content

Commit

Permalink
doco: restore "releasing" doco, will try it out momentarily.
Browse files Browse the repository at this point in the history
  • Loading branch information
bhamail committed Nov 8, 2021
1 parent 10c8efd commit fd2fba9
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,19 @@ However, some features may not be possible/present in older Python versions due

See our [CHANGELOG](./CHANGELOG.md).

## Releasing

We use [python-semantic-release](https://python-semantic-release.readthedocs.io/en/latest/) to generate patch releases
from commits to the `main` branch.

For example, to perform a "patch" release, add a commit to `main` with a comment like:

```
fix: Resolve vulnerability: CVE-2020-27783 in lxml
```

To avoid performing a release after a commit to the `main` branch, be sure your commit message includes `[skip ci] `.

## The Fine Print

Remember:
Expand Down

0 comments on commit fd2fba9

Please sign in to comment.