Release Process And Cadence

    • Maintainers commit to work on set of features and enhancements and create GitHub milestone to track the work.
    • We are trying to avoid delaying release and prefer moving the feature into the next release if we cannot complete it on time.
    • The new release is published every 2~3 month.
    • Critical bug-fixes are cherry-picked into the release branch and delivered using patch releases as frequently as needed, we will maintain the last 2 releases.

    We are using GitHub milestones to perform release planning and tracking. Each release milestone includes two type of issues:

    • Issues that maintainers committed to working on. Maintainers decide which features they are committing to work on during the next release based on their availability. Typically issues added offline by each maintainer and finalized during the contributors’ meeting or . Each such issue should be assigned to maintainer who plans to implement and test it.
    • Nice to have improvements contributed by community contributors. Nice to have issues are typically not critical, smallish enhancements that could be contributed by community contributors. Maintainers are not committing to implement them but committing to review PR from the community.

    In addition to the next milestone, we need to maintain a draft of the upcoming release milestone.

    We receive a lot of contributions from our awesome community, and we’re very grateful for that fact. However, reviewing and testing PRs is a lot of (unplanned) work and therefore, we cannot guarantee that contributions (especially large or complex ones) made by the community receive a timely review within a release’s time frame. Maintainers may decide on their own to put work on a PR together with the contributor and in this case, the maintainer will self-assigned the PR and thereby committing to review, eventually merge and later test it on the release scope.

    Maintainers should drive testing and work on fixing last-minute issues before every release.

    The maintainers are responsible to drive releases and follow the standard operating procedure to make sure the quality of this release.

    1. Create a new release branch from the branch when release a new minor release.
    2. Create new patch releases corresponding to the release branch.
    3. Make sure the release materials are generated successfully from the Github actions:
    4. Update docs and examples to use the new release.
      • Create a new docs version for the new minor release.
      • Update the migration doc when release a new release.
      • Update the top tip in docusaurus.config.js for every patch release.

    Last updated on Feb 9, 2023 by dependabot[bot]