-
Notifications
You must be signed in to change notification settings - Fork 31
Orb Branch Workflow and Release Procedure
Shannon Weyrick edited this page Mar 29, 2022
·
9 revisions
- The source of truth for the version is the root
VERSION
file, which is semantic versioning plus an optional suffix. - There are three special branches:
main
,develop
, andproduction
.main
gets stable/self-host merges,develop
is continuous integration branch for feature development with continuous deployment to Staging environment, andproduction
contains production orb.live releases. - For in-repo development (not forks), development happens in ephemeral
feature/*
branches, for examplefeature/FEATURE-NAME
orfeature/ISSUE-ID
, which should be branched fromdevelop
- For extra-repo development (forks), development can happen directly in
develop
branch of the fork - Upon feature completion, a PR is created against the
develop
branch; CI will integrate, test, and build packages. If CI is green and the PR is approved, the change lands intodevelop
branch. - Pushes to
develop
branch will build and push packages with the-develop
suffix on the version, anddevelop
,VERSION-develop
andVERSION-develop-HASH
tags on docker hub. - On stable release,
develop
is merged tomain
. Once inmain
, the version should be updated to remove any version suffix. - Update version notice and download links on getorb.io