Skip to content

MPF release checklist

Help us write it!

This section is unwritten or needs an update or edit. Can you help write it? Get your name in lights and geeky pinball bragging rights! Hit the magic sparkly wand to the right of the title to see this page source on GitHub. Then add/edit and submit your change. It's easy!

This needs to be updated. Nothing below here applies anymore:

What to do to make a MPF release?

  • Update MPF Release Notes (mpf-docs repository dev branch)

  • Create draft blog post in missionpinball-website repository (in _draft folder)

  • Create a.bb.x branch (e.g. 0.50.x) and push it based on dev

    • mpf repository
    • mpf-mc repository
    • mpf-monitor repository
    • mpf-examples repository
    • mpf-debian-installer repository

  • Create a.bb branch (e.g. 0.50) and push it based on latest branch in mpf-docs repository

  • Add a.bb to versions on readthedocs and wait until it finished building

  • Remove a.bb from redirects in readthedocs

  • Add a.bb + 1 to redirects in readthedocs

  • Increase version to a.bb.0 on a.bb.x branch

    • mpf repository
    • mpf-mc repository
    • mpf-monitor repository

  • Set version to a.bb.x in mpf-mc repository in appveyor.yml

  • Wait until all builds pass

  • Increase version to a.bb.0-dev0 (bb + 1 or a + 1) on dev branch

    • mpf repository
    • mpf-mc repository
    • mpf-monitor repository

  • Update latest branch on mpf-docs

    • Remove branch protection
    • Set current_branch to a.bb.x in conf.py
    • Set branch in .travis.yml to a.bb.x
    • Remove --pre from install notes
    • Update linux installer references to a.bb.x instead of dev
    • Push dev branch to latest (hard push)
    • Re-add branch protection

  • Update dev branch on mpf-docs

    • Update version to next release in conf.py

  • Protect branches

    • a.bb.x on mpf repository
    • a.bb.x on mpf-mc repository
    • a.bb.x on mpf-monitor repository
    • a.bb.x on mpf-examples repository
    • a.bb on mpf-docs repository
    • a.bb.x on mpf-debian-installer repository

  • Publish release post on forum

  • Increase version in forum header

  • Publish release post on pinside

  • Publish release post on slack

  • Delete pre releases on pypi

    • mpf
    • mpf-mc
    • mpf-monitor

  • Tag Release on github

    • mpf
    • mpf-mc

Something missing or wrong? You can fix it!

This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?

Please help us! You can fix it yourself and be an official "open source" contributor!

It's easy! See our Beginner's guide to editing the docs.

Page navigation via the keyboard: < >

You can navigate this site via the keyboard. There are two modes:

General navigation, when search is not focused:

  • F , S , / : open search dialog
  • P , , : go to previous page
  • N , . : go to next page

While using the search function:

  • Down , Up : select next / previous result
  • Esc , Tab : close search
  • Enter : go to highlighted page in the results