Skip to content

Commit b0c8a68

Browse files
committed
add section about releasing through GH releases, including badge to releases
1 parent 66f1601 commit b0c8a68

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,13 @@ This updates the git repository, and sometimes is a large diff and can cause git
5555
```bash
5656
git config --global http.postBuffer 157286400
5757
```
58+
59+
## Deployment to GH releases
60+
61+
### How to publish
62+
63+
As of this first step towards GH releases, publication is done by pushing a tag to github, which has the effect of making a release named after that tag
64+
65+
### Browse available versions
66+
67+
Published versions of the `article` and `book` themes can be found [![as GH releases](https://img.shields.io/badge/as%20GH%20releases-blue?logo=github&style=flat-square)](https://github.com/jupyter-book/myst-theme/releases)

0 commit comments

Comments
 (0)