Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add information how to make a release #113

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add information how to make a release #113

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions doc/release.md
View file
Open in desktop
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