Skip to main content

Release train / deployment

This section outlines the release train process for managing and deploying documentation versions using Docusaurus, which can be seen as a parallel to managing releases of software, such as CWAs (Cloud Web Applications). The release train metaphor emphasizes a structured and predictable schedule for deploying updates, ensuring that all changes align with the production release timeline.

Versioning Strategy​

Versioning is a critical aspect of the release train process. Each release is tagged with a semantic version number (e.g., 1.50.0), which helps in tracking changes and ensuring compatibility. The versioning strategy follows the pattern:

  • Major: Introduces breaking changes.
  • Minor: Adds new features without breaking existing functionality.
  • Patch: Fixes bugs or minor issues.

For more details, refer to the Semantic Versioning documentation.

Communication and Collaboration​

Effective communication is key to the success of the release train. Teams are encouraged to:

  • Regularly update the status of their components in the proposal PR.
  • Use the Confluence Release Calendar to align with the deployment schedule.
  • Coordinate with the cloud platform team for any pre-release preparations.

Best Practices​

To ensure a smooth release process:

  1. Test Early and Often: Validate changes in the test environment as soon as possible.
  2. Document Changes: Maintain clear documentation for all updates, including migration steps and rollback plans.
  3. Monitor Post-Deployment: After deploying to prd, monitor the system for any anomalies and address issues promptly.

By adhering to these practices, teams can minimize risks and ensure a reliable release process.