Skip to content

Commit 76e64ee

Browse files
author
alrex
authored
chore: document release process
1 parent 90033d2 commit 76e64ee

1 file changed

Lines changed: 23 additions & 0 deletions

File tree

RELEASING.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Releasing
2+
3+
Once all the changes for a release have been merged to master, ensure the following:
4+
5+
- [ ] version has been updated in `VERSION`, `lightstep/version.py` and `setup.cfg`
6+
- [ ] tests are passing
7+
- [ ] user facing documentation has been updated
8+
9+
# Publishing
10+
11+
Publishing to [pypi](https://pypi.org/project/lightstep/) is automated via GitHub actions. Once a tag is pushed to the repo, a new GitHub Release is created and package is published via the actions defined here: https://github.com/lightstep/lightstep-tracer-python/blob/master/.github/workflows/release.yml
12+
13+
```
14+
$ git clone git@github.com:lightstep/lightstep-tracer-python && cd lightstep-tracer-python
15+
# ensure the version matches the version beind released
16+
$ cat VERSION
17+
4.4.3
18+
$ cat lightstep/version.py
19+
LIGHTSTEP_PYTHON_TRACER_VERSION="4.4.3"
20+
$ cat setup.py | grep version
21+
version='4.4.3',
22+
$ git tag v4.4.3 && git push origin v4.4.3
23+
```

0 commit comments

Comments
 (0)