Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (31 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 2.16 KB
Raw

Release Process 🚀

We use release-please-action to automate versioning and changelog generation, along with a GitHub workflow that automatically publish the templates to brickhub.dev.

How it works:

  • 📌 On Every Commit to main:

    • Commits are analyzed using Conventional Commits.
    • If a version bump is needed, a release PR is automatically created or updated by release-please-action.
    • The release PR includes:
      • An updated CHANGELOG.md
      • A version bump in brick.yaml
    💡 Notes
    • Release PR's are created per template.
    • The GitHub Action workflow that automates the release process is configured in .github/workflows/release_please.yaml
    • release-please settings are defined in .release-please-config.json and .release-please-manifest.json
    • The release PR can be manually edited before merging.
    • The release PR should be merged ONLY when a new release is needed.

  • ✅ When the Release PR Is Merged:

    • A new Git tag is created.
    • A GitHub Release is published with the changelog.
    • A new version of the brick is automatically published in brickhub.dev.

    💡 Notes

    • GitHub Releases are created per template.
    • The publishing process is automatically triggered when a version tag is created.
    • The automated publishing workflows to brickhub.dev are defined in .github/workflows/publish_<template-name>.yaml

This document provides a good summary of how it works and how we use it, but we recommend that you also read the official documentation of Conventional Commits, Semantic Versioning, Publishing a Brick and release-please-action.