Skip to content

Commit 249f2b0

Browse files
committed
Add information how to make a release
1 parent c8a5789 commit 249f2b0

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

doc/release.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## How to make a release
2+
3+
Make sure main and data are in a clean state.
4+
5+
export RELEASEDATE=2022-01-17
6+
# Release for the main branch
7+
git tag -a v$RELEASEDATE
8+
# enter in editor:
9+
# v$RELEASEDATE
10+
#
11+
# Longer release details
12+
git push origin v$RELEASEDATE
13+
# Prepare data directory
14+
cd data
15+
# Avoid the tag being part of a branch that might be squashed
16+
git co --orphan data-release
17+
git rm --cached -r .
18+
rm -r *
19+
cd ..
20+
make data-update
21+
# check
22+
make data-status
23+
cd data
24+
# `git add` should already been done by make data-status
25+
# git status
26+
git commit -m "Generated from main <sha>"
27+
git tag -a data-$RELEASEDATE
28+
# enter in editor:
29+
# data-$RELEASEDATE
30+
#
31+
# Longer release details
32+
git push origin data-$RELEASEDATE
33+

0 commit comments

Comments
 (0)