About News Download Docs Forum Bugs Contact





Grimoire release process

This page describes how stable grimoire is updated regularly.


1. On the 1st of each month, the grimoire version currently in the test (master) branch is branched to the next stable-rc:

2. At the same time, test gets its VERSION incremented as well; normally this means bumping the minor version; major version updates are at the discretion of the Grimoire Lead:

3. A new page is created for the new release by using Grimoire/Release/Template to make Grimoire/stable/$STABLE_RC_VERSION page.

4. The release testing proceeds as described on the release page, with the following additions:

5. When the release is complete, the new stable is branched from stable-rc:

6. A release tag and tarball are generated as described in tarball update.

7. After the release, any fixed bugs against this stable-rc or the previous stable need to be closed.

8. If the new release is not done when the 1st of the next month arrives, that branch is abandoned and a new -rc is created and the process starts over.

Tarball update

This section described how to update a grimoire tarball.


1. Get a local grimoire checkout to push updates from; this should usually be different from the one you do work in, because the branch it's on will change behind your back and will usually not even be a real branch.

2. Get the script at distro.sourcemage.org:/usr/local/sbin/update-grimoire and edit the top section with your local information (key ids, paths, etc.). If you are not using devel Sorcery, be sure you have the latest /usr/local/sbin/generate-grimoire-version-cache in the same location as your update-grimoire script.

Note: currently the stable key is shared (key ID 0xB6632F2E), while stable-rc uses per-developer keys found in the grimoire-stable-rc keyring.

Doing an update

1. Verify the stable or stable-rc version at the top of the local update-grimoire script is current.

if updating stable only

2. In your normal edit grimoire:

end if updating stable only

3. update-grimoire $GRIMOIRE

4. Follow the prompts.

The newly uploaded tarball will show up on http://master.download.sourcemage.org every 3 hours, UTC (12:00, 3:00, 6:00, etc.). Mirrors will update from there on their own schedules.

How to test

  1. Pick some spells from the lists on Grimoire/stable/$STABLE_RC_VERSION release page and put your name in as the Volunteer. Optionally add some spells to the Extra spells section, with your name as Volunteer.
  2. For your spells, search bug-tracker for any existing bugs. Decide which are gating and which aren't, and fill out the Notes column appropriately. Put an X in the Searched column so we know someone has done the search.
  3. Get a machine with the current stable on it: either your regular box or just a chroot/vm image.
  4. Cast your spells from stable if you don't have them already. If they won't install, ignore it and keep going.
  5. Get stable-rc on that machine, either via scribe add stable-rc or just using the git branch directly.
  6. Try updating your spells, or if they wouldn't install in stable try casting them directly from -rc.
  7. Note any failures, issues, etc. in the Notes column. File bugs as necessary, noting which new issues are gating and which aren't.
  8. Once the spell has cast for you without any gating problems, put an X in the Signed-Off column (unless otherwise specified this applies to x86).

It's up to you to define "gating" for your spells.

Keeping us informed of what you've found is more important than fixing everything yourself. If you run out of time someone else can pick up for you but only if they can tell what's going on.

If you're already running stable somewhere, you don't need to wait, just test with that. Otherwise, download the chroot/vm image.

Actions on list of supported spells

Place an X in the signed off column once you have signed off on the spell. If you happen to test a full system-upgrade, feel free to put an X and your nick in the Alt Sign-Off column for any spells that work for you.

We release once all spells on the list have:

  1. An X in the Searched column indicating someone has at least searched the bug-tracker for known issues, even if they found nothing.
  2. Sign-off by the volunteer owning that spell this release, or sign-off by someone in the Alt Sign-Off column if there are no gating bugs noted by the owner.