Skip to content

Commit eb0ec3d

Browse files
committed
Add release steps
1 parent f6343be commit eb0ec3d

File tree

2 files changed

+58
-6
lines changed

2 files changed

+58
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@
33
A bot to help facilitate the [Matrix Spec Proposal
44
Process](https://matrix.org/docs/spec/proposals).
55

6-
However it is written in a generic way such that it can be used for any project wanting to
6+
However, it is written in a generic way such that it can be used for any project wanting to
77
make use of a similar process.
88

9+
The official instance of this bot is running under the GitHub user @mscbot. A user guide is available
10+
here: [User Guide](docs/user_guide.md).
11+
12+
The infrastructure for the official instance is
13+
hosted [on the Matrix.org Foundation's ArgoCD](https://argocd.vpn.infra.matrix.org/applications/argocd/mscbot)
14+
(non-public link).
15+
916
## Installation
1017

1118
### Getting the code
@@ -115,10 +122,6 @@ Put your config file somewhere and then mount it via a volume.
115122
docker run -v /path/to/config/dir:/config matrixdotorg/mscbot-python python -m mscbot -c /config/config.yaml
116123
```
117124

118-
## User guide
119-
120-
See [docs/user_guide.md](docs/user_guide.md).
121-
122125
## Development
123126

124127
Several python dependencies are necessary to support development scripts. They can be installed by running:
@@ -137,4 +140,8 @@ Before submitting a PR, make sure to lint your code:
137140

138141
```
139142
./scripts-dev/lint.sh
140-
```
143+
```
144+
145+
### Creating a new release
146+
147+
See [RELEASING.md](RELEASING.md).

RELEASING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Releasing `mscbot-python`
2+
3+
To make a new release of `mscbot-python`, perform the following.
4+
5+
1. Determine the new version number. This project follows [semantic versioning](https://semver.org/). Store the release version in an environment variable called `RELEASE_VERSION`.
6+
7+
```
8+
export RELEASE_VERSION=X.Y.Z
9+
```
10+
11+
**Note:** Do not include a `v` before the version number.
12+
13+
1. Update `setup.py` with the new version number:
14+
15+
```
16+
sed -i "s/version=\"[0-9]\+\.[0-9]\+\.[0-9]\+\"/version=\"${RELEASE_VERSION}\"/" setup.py
17+
```
18+
19+
1. Stage, commit and push the changes:
20+
21+
```
22+
git add setup.py
23+
git commit -m "$RELEASE_VERSION"
24+
```
25+
26+
1. Create a new git tag:
27+
28+
```
29+
git tag $RELEASE_VERSION -m "$RELEASE_VERSION"
30+
```
31+
32+
1. Push the tag to the repository:
33+
34+
```
35+
git push origin $RELEASE_VERSION
36+
```
37+
38+
**Note:** A docker image will be automatically created and published when
39+
the tag is uploaded.
40+
41+
1. [Create a new release](https://github.com/matrix-org/mscbot-python/releases/new)
42+
on GitHub.
43+
Select the tag that was just created and click "Generate release notes".
44+
45+
1. Press "Publish release", and you're done! 🍾

0 commit comments

Comments
 (0)