Skip to content

Commit 82f6eb8

Browse files
committed
Document how to make releases
1 parent 93b732a commit 82f6eb8

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,37 @@ plain react without typescript seems the correct choice. We will _not_ make
9797
this into a super-heavy, complex application - just a fairly simple one that
9898
uses react.
9999

100+
## Making a Release
101+
102+
We have [automation](https://github.com/pypa/gh-action-pypi-publish/)
103+
set up to make releases to [PyPI](https://pypi.org/project/jupyterhub-fancy-profiles/).
104+
We should release early and often!
105+
106+
1. On your local checkout, make sure you are up to date with the `main` branch
107+
108+
```bash
109+
git checkout main
110+
git stash
111+
git pull upstream main # or git pull origin main, as needed
112+
```
113+
114+
2. Create a new git tag, with the version of the release.
115+
116+
```bash
117+
git tag -a v<version-number>
118+
```
119+
120+
Leave a simple message here. While ideally a changelog would also be nice,
121+
at a minimum simply say `Version <version-number>`
122+
123+
3. Push your tag to GitHub
124+
125+
```bash
126+
git push origin --tags
127+
```
128+
129+
4. That's it! A new release should be on PyPI shortly.
130+
100131
## Funding
101132

102133
Funded in part by [GESIS](http://notebooks.gesis.org) in cooperation with

0 commit comments

Comments
 (0)