ReleaseProcess

Release Process

Magarena is released monthly, around the last weekend of the month. This page documents the process of releasing a new version of Magarena

Requirements

• has push access to https://github.com/magarena/magarena
• has push access to https://github.com/magarena/magarena.github.io
• permissions to post announcement on forum

Procedure

1. (Optional) Create a release branch to perform release work so as not block work on master

2. Write release notes for the new version in README.txt file

• make cards/fmt.txt will create a list of new cards separated by commas

3. Prepare repo

• Update card values, format lists, and cubes
• Remove added cards from scripts_missing folder
• Build release zips using make zips

4. git tag [ver] [commit]; git push [remote] master --tags

5. Create a new release on github via https://github.com/magarena/magarena/releases/edit/[ver] and upload the zip files to the release page

6. (Optional) Fix the labels using the correct-release-label rule from the Makefile

7. Update first post on https://magarena.github.io/

• set version field in magarena.github.io/_config.yml to new version number
• write a release post in magarena.github.io/_posts
• commit and push the changes

8. Announce the release on forum as an announcement

• edit the previous release post and change it back to a normal post
• create a new announcement topic with title "Magarena [ver]"
• set the topic icon to be the star icon
• the content of the post is the combination of the release post on the website and release notes from the README.txt file

9. Update the bug report topic

• lock the previous bug report topic
• create a new sticky topic for bug reports with title "Bug reports for Magarena [ver]"
• set the topic icon to be the exclaimation mark in a triangle icon

10. (Optional) Merge release changed back to master and delete release branch

11. (Optional but helpful!) bump source code to next version (eg. see 9afbecb) and add next version milestone in GitHub issues with expected release date.