Release Process

Release early, release often. This is a mantra from free software communities. It's accurate. You want to do your design work in the open, and get critical feedback as early as possible.



1. Stages

  • alpha1
    • Alpha is for preview purposes only.
    • it is intended to be a technology preview aimed at early adopters, testers, translators
    • Do not use alpha releases on production systems!
  • alpha2
  • beta1
    • Beta releases are appropriate for use with new development. Within beta releases, the features and compatibility should remain consistent. However beta releases may contain numerous and major unaddressed bugs.
  • beta2
    • is available for testers, extension developers, and other people who are curious to follow the development of the next release
  • rc1
    • Release Candidates are believed stable, having passed all internal testing, and with all known fatal runtime bugs fixed. However this release has not been in widespread use long enough to know for sure that all bugs have been identified.
      • wait to declare something RC until code stabilizes and critical bugs are fixed
    • feature freeze -> testing and debugging ->
      • This release is ready for widespread testing, and we’re encouraging everyone to download and test the beta releases. Please run the release through your usual routine, and let us know about any bugs or other issues that you find. Remember that this is a beta release, and is not suitable for use on production systems.
    • For translators, this is the first call to update the translations to the current set of strings, which should not change much until final.
  • rc2
  • final
    • also know as Production releases, are stable, having successfully passed through all earlier release stages and believed to be reliable, free of serious bugs, and suitable for use in production systems
    • All users are advised to upgrade.
  • m1
    • Maintenance release

2. Issue tracker

  • update issues in bugtracker
  • set release date

3. Change Log

XML

Feed Title: Release notes from wackowiki


6.3.1

Minor feature and bug fix release for 6.3.x series

  • replace jpeg_quality option with image_quality
    • off - No quality applied; each codec's own default
    • max - Maximum quality each codec offers
    • high - Visually near-lossless
    • medium - Good quality; typical for web delivery
    • low - Aggressive compression; small files
  • fix missing file entries in whatsnew action
  • filemeta: base file access check on the file's own page
  • fix SQLite FTS5 syntax error on special characters in search
  • allows now toc action in comments
  • rename option dark_mode to color_scheme
  • show_access_mode: show permissions link only for page owners
  • Formatter
    • fix missing page handler in wiki links ((Page/_source …))
    • support text fragments in wiki links (WikiPage#:~:text=from,to)
    • fix interwiki links with percent encoding and text fragments
    • fix Formatter URL handling for trailing punctuation and invalid hosts
    • fix unescaped link text in footnote and anchor links
    • fix table cells broken by auto footnotes
    • fix double-encoding of quotes in link() text and title
  • installer:
    • prevent orphan menu records when page_id is missing
    • prevent double-escaping of JSON-encoded toolbar config in installer
  • Translations
    • update Estonian
  • Libs

Security advisory

  • GHSA-3m55-jc3h-qwg9 — improper access control in the file metadata handler.
    All affected installations should upgrade.

Full Changelog: 6.3.0...6.3.1

4. Release Notes

  • Upgrade from previous versions
    • Component compatibility
    • Configuration
  • Highlights
  • Call for Localization
    • If you can help with languages other than English and German, it would be appreciated.
  • Testing
    • Most Annoying Bugs
      • While many bugs have been eliminated since the last beta, we still have a few remaining (and new) bugs that testers should be aware of:
  • Themes
  • Hacks / Patches

5. Build packages

  • tarball
  • zip
  • name the folder within the package according the release
    • wacko.r6.0.38
    • wacko.r6.2.1
    • wacko.r7.0.1

Set back error reporting level in constants.php

const PHP_ERROR_REPORTING			= 0;		

Set back error SQL mode to server in config.php

'sql_mode' => '0',		

Workflow:

  1. On your local machine (or CI), run:
    composer install --no-dev --optimize-autoloader		

  2. Create a clean distribution archive that includes everything users need.
  3. Upload the resulting .zip / .tar.gz as an asset to a new GitHub Release.

5.1. Create the Distribution Package

Place the script in your project root folder and run it. Ensure you've installed Composer.


Basic usage (default):
./build-release.sh --version=6.3.1 - pulls HEAD of master branch
Build from tag:
./build-release.sh --version=6.3.1 --source=6.3.1 - pulls version with 6.3.1 tag
Build from commit hash:
./build-release.sh --version=6.3.1-dev --source=e5266a8043f17fcef4a168ecaf6232bc6a38e9b8 - pulls version with the provided hash


build-release.sh

6. Repository

  • tag the release
  • branch final release

7. Update Files

  • Latest development version
  • Latest released testing version
  • Latest released stable version

7.1. Update file references

wackowiki-6.3.1.zip (5.7 MiB)


Development version
(see Repository)


Beta version
wackowiki-6.3.1.zip


8. Release notices and announcements