Skip to content

Latest commit

 

History

History
74 lines (51 loc) · 2.43 KB

RELEASE_GUIDE.md

File metadata and controls

74 lines (51 loc) · 2.43 KB

RELEASE GUIDE

This document provides a step-by-step guide for preparing, releasing, and deploying a new version of the application.

Table of Contents

  1. Pre-Release Checklist
  2. Version Bumping
  3. Post-Release Steps
  4. Hotfix Release
  5. Troubleshooting

Pre-Release Checklist

Before starting the release process, ensure:

  • All pull requests for the release are merged on next branch.
  • Create release/* branch from next branch.
  • Update version and dependencies the steps mentioned in Version Bumping.
  • Generate new version of documentation if there are any changes.
  • All unit, integration, and end-to-end tests pass.
  • Merge the PR for changelog automatically generated by the changelog pipeline.
  • Create a PR for the release/* branch to main branch.
  • Get approval from the team.
  • Merge the PR to main branch.
  • Relevant stakeholders are informed.

Version Bumping

  1. Determine the new version number based on Semantic Versioning:

    • Patch: Bug fixes (e.g., 1.0.1 → 1.0.2)
    • Minor: New features, backward-compatible (e.g., 1.0.2 → 1.1.0)
    • Major: Breaking changes (e.g., 1.1.0 → 2.0.0)

  2. Update the version in:

    • package.json and version.json files.
    • Make sure all dependencies in package.json are up-to-date and compatible with the new version.
    • Make sure all dependencies in version.json are up-to-date and compatible with the new version.
    • Update documentation version if necessary.
    • Update API version if necessary.

Post-Release Steps

  • Merge the main branch to next branch.

Hotfix Release

In case of a critical bug or security issue, a hotfix release is required. Follow these steps:

  1. Create a new branch from main branch with the name hotfix/*.
  2. Make the necessary changes and commit them.
  3. Update the version number in package.json and version.json files following the Version Bumping steps.
  4. Create a PR for the hotfix/* branch to main branch.
  5. Get approval from the team.
  6. Merge the PR to main branch.
  7. Merge the main branch to next branch.

Troubleshooting

  • Build failed: Check logs for errors in dependencies or configurations.
  • Tests failed: Investigate the specific test cases and fix issues.