Open Food Network Release Discussion: A Comprehensive Guide

Releasing new versions of the Open Food Network (OFN) involves a structured process to ensure stability and effective communication. This guide outlines the steps and considerations for each release, from drafting and testing to deployment and notification. Let's dive into the detailed procedures that ensure a smooth release cycle for the Open Food Network.

1. Drafting on Friday

Drafting a new release is a critical first step in the Open Food Network release process. This stage involves merging pull requests, updating translations, incrementing the version number, and drafting the release notes. Each of these steps is vital for ensuring that the release is stable, up-to-date, and well-documented. Let's explore each element in detail.

Merging Pull Requests

Firstly, it’s essential to merge all pull requests that are in the [Ready To Go] column. This ensures that all approved features, bug fixes, and improvements are included in the upcoming release. Pull requests represent contributions from various developers, and merging them integrates these changes into the main codebase. This step ensures that the release reflects the latest developments and enhancements.

Including Translations

Secondly, translations must be included to support the Open Food Network's global user base. The command script/release/update_locales facilitates this process. To execute this script, you need the [Transifex Client] installed on your local development environment. Translations are critical for making the platform accessible to users in different regions and languages, fostering a more inclusive community.

Incrementing Version Number

Thirdly, the version number needs to be incremented using the command git push upstream HEAD:refs/tags/vX.Y.Z. This step is crucial for version control and helps users identify which version of the software they are using. It's important to check for [minor or major breaking changes] before incrementing the version number. The type of increment (major, minor, or patch) depends on the nature of the changes included in the release. Here’s a breakdown:

• Major: Indicates significant changes that may require server updates (e.g., provisioning with ofn-install).
• Minor: Signifies a substantial change that is irreversible, such as a migration deleting data.
• Patch: Represents all other changes, typically bug fixes and minor enhancements. A shortcut command, script/release/tag, is available for patch releases.

Drafting Release Notes

Finally, a [Draft new release] should be created. Reviewing previous [releases] can provide inspiration for formatting and content. The process involves selecting the new release tag and generating release notes. It's crucial to carefully check the generated notes to ensure all items are arranged in the correct category. Release notes inform users about the changes, improvements, and bug fixes included in the release, aiding in adoption and understanding.

By diligently following these drafting steps, the Open Food Network ensures each release is well-prepared, incorporating the latest updates and improvements while maintaining clarity and accessibility for its users.

2. Testing

Testing is a pivotal phase in the Open Food Network release cycle, ensuring the stability and reliability of the new version. This stage involves moving the issue to