CI/CD

Branch Management

---
title: Trunk-based with CD
---
%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': 'main'}} }%%
gitGraph
   commit tag: "0.37.0"

   branch "feat/add-foo-123"
   branch "feat/add-bar-123"

   checkout "feat/add-foo-123"
   commit id: "feat(foo): ..."
   commit id: "doc(foo): ..."
   checkout main
   merge "feat/add-foo-123" tag: "v1.0.0.canary.1"

   branch "feat/add-baz-123"
   commit id: "feat(baz): ..."
   commit id: "doc(baz): ..."
   commit id: "test(baz): ..."

   checkout "feat/add-bar-123"
   commit id: "chore(bar): ..."
   commit id: "feat(bar): ..."
   checkout main
   merge "feat/add-bar-123" tag: "v1.0.0.canary.2"

   checkout main
   branch "version/1.0.0"
   commit id: "bump(v1.0.0): pyproject.toml"

   checkout main
   branch release
   merge "version/1.0.0"
   commit id: "release(v1.0.0): ..." tag: "v1.0.0"

   checkout main
   merge release
   checkout main
   merge "feat/add-baz-123" tag: "v1.1.0.canary.1"

Protected Branches

main (default), the trunk
release

The trunk is considered stable and MUST:

Reject commits not included in a Pull Request
Require Docs and TestNet deployments to be healthy to accept commits from release
Meet the quality criteria defined in the CI/CD pipeline

The release branch MUST:

Be kept in sync with main
Be used to generate release tags
Reject commits from branches other than main that are:
- Not included in a Pull Request
- Have a diff that is not strictly equal to the pyproject.toml version bump.

The CI/CD pipeline ensures that:

The main branch contains release-grade code at any time (both for Smart Contracts and Docs)
The release branch is synced with main and used only to generate release tags (reflected as pyproject.toml version)

Unprotected Branches

Features, major refactoring, dependency bumps, or bugfixes SHALL be carried out on a dedicated unprotected branch pointing to the trunk (main).

The pyproject.toml release version bumps SHALL be carried out on a dedicated unprotected branch pointing to the release branch.

Draft Pull Requests from unprotected branches, either to main or release, SHOULD skip the CI.

Deployments

The CD makes use of the following deployment environments:

github-pages: to host the static documentation (mdBook)
contract-testnet: to continuously deploy Smart Contracts to the Algorand TestNet
contract-mainnet: to deploy Smart Contracts to the Algorand MainNet on release

Implementation

The CI/CD pipeline is implemented with the following automated workflows:

Smart Contracts CI (tests, lint, output stability, mock deployment)
Smart Contracts CD (to TestNet)
Documentation CI (tests, lint)
Documentation CD (to GitHub Pages)
Release CI (validate release tag, version, etc.)
Release (to MainNet)

And the following manually dispatchable workflows: