Skip to content

Commit ddb3ec9

Browse files
authored
Update releasing docs (#120)
I failed to find the release docs under docs - our other repos keep them in RELEASING.md. So, move them to the conventional place, and update them with the notes I made during the release of v0.1.5.
1 parent fad2abd commit ddb3ec9

File tree

3 files changed

+46
-32
lines changed

3 files changed

+46
-32
lines changed

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
include *.in
22
include *.py
3+
include *.md
34
include LICENSE
45
include tox.ini
56
include requirements.txt
67
include .coveragerc
78
include .codecov.yml
89
recursive-include tests *.py
9-
recursive-include docs *.md

RELEASING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# How to release `matrix-synapse-ldap3`
2+
3+
Releasing `matrix-synapse-ldap3` involves bumping the version number, creating
4+
a new tag on Github, then uploading release packages to
5+
[PyPi](https://pypi.org).
6+
7+
You will need push access to this repo as well as an account on PyPi with push
8+
access to the
9+
[matrix-synapse-ldap3](https://pypi.org/project/matrix-synapse-ldap3/) package.
10+
11+
1. Edit the `__version__` variable of `ldap_auth_provider.py` to the new release
12+
version. This repository uses [Semantic Versioning](https://semver.org/).
13+
14+
1. Set a variable to the version number for convenience:
15+
```sh
16+
ver=$(python3 -c 'import ldap_auth_provider; print(ldap_auth_provider.__version__)')
17+
```
18+
19+
1. Push your changes:
20+
```sh
21+
git add -u && git commit -m $ver && git push
22+
```
23+
24+
1. Create a signed git tag for the release:
25+
```sh
26+
git tag -s v$ver
27+
```
28+
29+
Set the first line of the message to `vX.Y.Z`, and the rest to the changes since the last release (hint: `git log --pretty=%s --reverse v<old ver>...`)
30+
31+
1. Push the tag:
32+
```sh
33+
git push origin tag v$ver
34+
```
35+
36+
1. Build and upload to PyPI:
37+
```sh
38+
python setup.py sdist
39+
twine upload dist/matrix-synapse-ldap3-$ver.tar.gz
40+
```
41+
42+
1. Create release on GH project page:
43+
```sh
44+
xdg-open https://github.com/matrix-org/matrix-synapse-ldap3/releases/edit/v$ver
45+
```

docs/how-to-release.md

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)