Skip to content

Commit

Permalink
Add information how to make a release
Browse files Browse the repository at this point in the history
  • Loading branch information
perlpunk committed Jan 18, 2022
1 parent 45db50a commit a0ddbfd
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions doc/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
## How to make a release

Make sure main and data are in a clean state.

export RELEASEDATE=2022-01-17
# Release for the main branch
git tag -a v$RELEASEDATE
# enter in editor:
# v$RELEASEDATE
#
# Longer release details
git push origin v$RELEASEDATE
# Prepare data directory
cd data
# Avoid the tag being part of a branch that might be squashed
git co --orphan data-release
git rm --cached -r .
rm -r *
cd ..
make data-update
# check
make data-status
cd data
# `git add` should already been done by make data-status
# git status
git commit -m "Generated from main <sha>"
git tag -a data-$RELEASEDATE
# enter in editor:
# data-$RELEASEDATE
#
# Longer release details
git push origin data-$RELEASEDATE

0 comments on commit a0ddbfd

Please sign in to comment.