Configure a supported tracking branch to get Discourse software updates

[Discourse]

This guide explains how to configure a supported tracking branch for your Discourse instance to manage software updates.

Required user level: Systen Administrator

Console access is required.

Managing your Discourse instance’s tracking branch determines the frequency and type of updates you receive. This guide explains the different tracking branches available and provides a step-by-step approach to changing the branch on your setup.

Summary

Discourse offers three primary branches for tracking software updates: tests-passed, stable, and beta. This documentation explains the purpose of each branch, their key features, and how to configure them in your Discourse instance.

Supported branches

tests-passed

Recommended Default
This branch provides the latest bug fixes and compatibility updates for plugins. Every passing commit from the main branch is tested by the build server and added to the tests-passed branch after successful verification.

• Suitable for sites that want to stay up to date.
• Sites are only notified about new updates during beta releases but can update manually at any time.

stable

For Sites That Value Stability

The stable branch is intended for sites prioritizing stability and security over continuous updates.

• Released every 4–6 months.
• Only security fixes are backported between releases.
• May have limited compatibility with community plugins and theme components.

Note: Not receiving regular maintenance updates can leave some features outdated or visually inconsistent.

beta

Rarely Preferred

The beta branch is a milestone release that represents a collection of commits regularly pushed from tests-passed.

• Notifies administrators when a new collection of updates becomes available.
• Ideal for meeting milestones but generally not recommended due to limited advantages over tests-passed.

Other branches or references

Tracking other branches (e.g., custom branches or specific commit SHAs) is discouraged unless you have a specific need and expertise to support it.

Instructions for configuring your tracking branch

Follow these steps to configure the desired branch in your Discourse instance:

1. Access the configuration file
   Open the app.yml configuration file by running the following commands in your console:

cd /var/discourse
git pull
nano containers/app.yml

The nano editor will open the configuration file.
2. Edit the tracking branch
Locate the version parameter by searching for the word “version” in the file:

params:  
## Which Git revision should this container use? (default: tests-passed)  
#version: tests-passed  

• Uncomment the version line.
• Replace tests-passed with your desired branch name (e.g., stable).Example:

params:  
## Which Git revision should this container use? (default: tests-passed)  
version: stable  

3. Save and exit

• Press Ctrl+O to save your changes.
• Press Enter to confirm.
• Use Ctrl+X to exit the editor.

4. Rebuild the container
   Once the changes are made and saved, rebuild the container to apply the new configuration:

git pull
./launcher rebuild app

This process might cause temporary downtime. Ensure to update the instance during non-working hours if possible.

Last edited by @SaraDev 2024-11-21T01:35:26Z

Check document

Perform check on document: