Skip to content
This repository was archived by the owner on Nov 15, 2024. It is now read-only.

Commit 02e491f

Browse files
committed
Add brief docs on creating releases
1 parent 4ea20d1 commit 02e491f

File tree

2 files changed

+28
-0
lines changed

2 files changed

+28
-0
lines changed

docs/creating_releases.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
===============
2+
Release Process
3+
===============
4+
5+
The following document explains the manual release process.
6+
7+
1. Prepare release notes
8+
- Run `git tag` to see release names
9+
- Run `git log <prev_tag>..HEAD` to see all changes since last release.
10+
- We typically only pick out the large changes that will affect users or
11+
developers.
12+
2. Add notes to `CHANGELOG` file in restructed text format
13+
3. Pick a release name
14+
- We're loosely using semantic versioning.
15+
4. Create a tag locally for the release name
16+
- `git tag <name>`
17+
5. Push tag to github.com
18+
- `git push origin <name>`
19+
6. Add release notes to github.com
20+
- Click 'releases' tab on main github project page
21+
- Click 'tags'
22+
- Click 'Add release notes'
23+
- Fill out info in markdown!
24+
25+
** Yes, it's annoying we have release notes in rst and markdown.** We could
26+
potentially automate this or remove the redundancy in the future. Pull
27+
Requests for this would be accepted. :)

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ Contents:
2828
model_api
2929
remote_api
3030
utils
31+
creating_releases
3132

3233

3334
==================

0 commit comments

Comments
 (0)