chore: automate releases (#319)

Author: matiasleyba

.github/.cspell/words_dictionary.txt

@@ -1,4 +1,5 @@
 # Actual english words (or common abbreviations) missing from CSpell:
+brickhub # BrickHub is a platform where developers can discover, install, and publish reusable templates called bricks
 CLI # Abbreviation for Command Line Interface.
 CLIs # Plural of the abbreviation for Command Line Interface.
 CLI's # Belonging to a CLI.

.github/workflows/release_please.yaml

@@ -0,0 +1,32 @@
+name: release_please
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - main
+    paths:
+      - 'very_good_core/**'
+      - 'very_good_dart_cli/**'
+      - 'very_good_dart_package/**'
+      - 'very_good_flutter_plugin/**'
+      - 'very_good_flutter_package/**'
+      - 'very_good_docs_site/**'
+      - 'very_good_flame_game/**'
+      - 'very_good_wear_app/**'
+
+jobs:
+  create_release_pr:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: googleapis/release-please-action@v4
+        id: release-please
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_TOKEN }}
+          manifest-file: ".release-please-manifest.json"
+          config-file: ".release-please-config.json"

.release-please-config.json

@@ -0,0 +1,80 @@
+{
+  "$schema": "https://raw.githubusercontent.com/googleapis/release-please/main/schemas/config.json",
+  "changelog-sections": [
+    { "type": "feat", "section": "Features" },
+    { "type": "fix", "section": "Bug Fixes" },
+    { "type": "refactor","section": "Refactors" },
+    { "type": "chore", "section": "Miscellaneous Chores" },
+    { "type": "docs", "section": "Docs" }
+  ],
+  "pull-request-header": ":rotating_light: There are changes ready for release :rocket:\n\nℹ Merge this PR once the team confirms the release is ready.\n",
+  "pull-request-title-pattern": "chore(${component}): ${version}",
+  "separate-pull-requests": true,
+  "component-no-space": true,
+  "packages": {
+    "very_good_core": {
+      "release-type": "simple",
+      "version-file": "version.txt",
+      "component": "very_good_core",
+      "extra-files": [
+        "brick.yaml"
+      ]
+    },
+    "very_good_dart_cli": {
+      "release-type": "simple",
+      "version-file": "version.txt",
+      "component": "very_good_dart_cli",
+      "extra-files": [
+        "brick.yaml"
+      ]
+    },
+    "very_good_dart_package": {
+      "release-type": "simple",
+      "version-file": "version.txt",
+      "component": "very_good_dart_package",
+      "extra-files": [
+        "brick.yaml"
+      ]
+    },
+    "very_good_docs_site": {
+      "release-type": "simple",
+      "version-file": "version.txt",
+      "component": "very_good_docs_site",
+      "extra-files": [
+        "brick.yaml"
+      ]
+    },
+    "very_good_flame_game": {
+      "release-type": "simple",
+      "version-file": "version.txt",
+      "component": "very_good_flame_game",
+      "extra-files": [
+        "brick.yaml"
+      ]
+    },
+    "very_good_flutter_package": {
+      "release-type": "simple",
+      "version-file": "version.txt",
+      "component": "very_good_flutter_package",
+      "extra-files": [
+        "brick.yaml"
+      ]
+    },
+    "very_good_flutter_plugin": {
+      "release-type": "simple",
+      "version-file": "version.txt",
+      "component": "very_good_flutter_plugin",
+      "extra-files": [
+        "brick.yaml"
+      ]
+    },
+    "very_good_wear_app": {
+      "release-type": "simple",
+      "version-file": "version.txt",
+      "component": "very_good_wear_app",
+      "extra-files": [
+        "brick.yaml"
+      ]
+    }
+  }
+}

.release-please-manifest.json

@@ -0,0 +1,11 @@
+{
+    "very_good_core": "1.0.0",
+    "very_good_dart_cli": "1.0.0",
+    "very_good_dart_package": "1.0.0",
+    "very_good_docs_site": "1.0.0",
+    "very_good_flame_game": "1.0.0",
+    "very_good_flutter_package": "1.0.0",
+    "very_good_flutter_plugin": "1.0.0",
+    "very_good_wear_app": "1.0.0"
+}
+  

CONTRIBUTING.md

@@ -0,0 +1,43 @@
+### Release Process 🚀
+
+We use [`release-please-action`][release-please-action-link] to automate versioning and changelog generation, along with a GitHub workflow that automatically publish the templates to [brickhub.dev][brickhub_link].
+
+### How it works:
+
+- 📌 **On Every Commit to main:**
+    - Commits are analyzed using [Conventional Commits][conventional_commits_link].
+    - If a version bump is needed, a **release PR** is automatically created or updated by [`release-please-action`][release-please-action-link].
+    - 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.
+
+<br />
+
+- ✅ **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][brickhub_link].
+
+    #### 💡 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][brickhub_link] are defined in `.github/workflows/publish_<template-name>.yaml`
+
+<br />
+
+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][conventional_commits_link], [Semantic Versioning][sem_ver_link], [Publishing a Brick][brickhub_publishing_link] and [`release-please-action`][release-please-action-link].
+
+[brickhub_link]: https://brickhub.dev/
+[brickhub_publishing_link]: https://docs.brickhub.dev/mason-publish
+[sem_ver_link]: https://semver.org/
+[release-please-action-link]: https://github.com/googleapis/release-please-action
+[conventional_commits_link]: https://www.conventionalcommits.org/en/v1.0.0

very_good_core/CHANGELOG.md

@@ -1,8 +1,9 @@
-# 1.0.0
+
+## 1.0.0
 
 refactor(very_good_core)!: remove root-level project_name folder from brick structure.
 
-## Migration details
+### Migration details
 
 The `very_good_core` brick no longer includes a top-level project name folder.
 This allows generating the project directly into the current or a custom directory.
@@ -17,14 +18,14 @@ mason make very_good_core
 mason make very_good_core -o ./output_folder
 ```
 
-# 0.11.1 
+## 0.11.1 
 
 - docs: update test command in very good core README ([#287](https://github.com/VeryGoodOpenSource/very_good_templates/pull/287))
 - chore(very_good_core): deprecated script-based application of the flutter gradle plugin ([#249](https://github.com/VeryGoodOpenSource/very_good_templates/pull/249))
 - chore(very_good_core): update format on MainActivity.kt ([#290](https://github.com/VeryGoodOpenSource/very_good_templates/pull/290))
 - fix(android): correct source sets to ensure plugin compatibility ([#292](https://github.com/VeryGoodOpenSource/very_good_templates/pull/292))
 
-# 0.11.0
+## 0.11.0
 
 - chore(deps): bump very_good_analysis from 6.0.0 to 7.0.0 in /very_good_core/hooks [#233](https://github.com/VeryGoodOpenSource/very_good_templates/pull/233)
 - chore: tighten template dependencies [#237](https://github.com/VeryGoodOpenSource/very_good_templates/pull/237)
@@ -36,63 +37,63 @@ mason make very_good_core -o ./output_folder
 - fix(very_good_core): Update concurrency group name template [#255](https://github.com/VeryGoodOpenSource/very_good_templates/pull/255)
 - chore: bump very_good_analysis to 9.0.0 [#261](https://github.com/VeryGoodOpenSource/very_good_templates/pull/261)
 
-# 0.10.0
+## 0.10.0
 
 - feat: update pull request templates to add `test` type option ([#214](https://github.com/VeryGoodOpenSource/very_good_templates/pull/214))
 - chore: update to Flutter 3.27 and Dart 3.6 ([#223](https://github.com/VeryGoodOpenSource/very_good_templates/pull/223))
 
-# 0.9.0
+## 0.9.0
 
 - chore: update copyright year in Windows Runner.rc ([#188](https://github.com/VeryGoodOpenSource/very_good_templates/pull/188))
 - refactor: move current_year out from configuration ([#193](https://github.com/VeryGoodOpenSource/very_good_templates/pull/193))
 - fix: update android build versions ([#205](https://github.com/VeryGoodOpenSource/very_good_templates/pull/205))
 
-# 0.8.0
+## 0.8.0
 
 - feat: update to Flutter 3.24 and Dart 3.5 ([#177](https://github.com/VeryGoodOpenSource/very_good_templates/pull/177))
 
-# 0.7.2
+## 0.7.2
 
 - fix: update application identifier usage ([#148](https://github.com/VeryGoodOpenSource/very_good_templates/pull/148))
 - feat: use application id on macOS project ([#159](https://github.com/VeryGoodOpenSource/very_good_templates/pull/159))
 - fix: default id when application id is empty ([#165](https://github.com/VeryGoodOpenSource/very_good_templates/pull/165))
 
-# 0.7.1
+## 0.7.1
 
 - style: Adding extra space to the application opening tag ([#126](https://github.com/VeryGoodOpenSource/very_good_templates/pull/126))
 - chore: update Java versions on Very Good Core ([#128](https://github.com/VeryGoodOpenSource/very_good_templates/pull/128))
 - chore: update to Very Good Analysis 6.0.0 ([#135](https://github.com/VeryGoodOpenSource/very_good_templates/pull/135))
 - chore: tighten template dependencies ([#137](https://github.com/VeryGoodOpenSource/very_good_templates/pull/137))
 
-# 0.7.0
+## 0.7.0
 
 - feat!: ensure template uses Flutter 3.22 with Dart 3.4 ([#97](https://github.com/VeryGoodOpenSource/very_good_templates/pull/97))
 - fix: update index.html to support latest convention ([#106](https://github.com/VeryGoodOpenSource/very_good_templates/pull/106))
 
-# 0.6.1
+## 0.6.1
 
 - fix: deprecated imperative apply of Flutter's Gradle plugins ([#70](https://github.com/VeryGoodOpenSource/very_good_templates/pull/70))
 
-# 0.6.0
+## 0.6.0
 
 - chore: migrate very_good_core ([#1](https://github.com/VeryGoodOpenSource/very_good_templates/pull/1))
 - feat!: update to Flutter 3.19.0 ([#24](https://github.com/VeryGoodOpenSource/very_good_templates/pull/24))
 - chore: update bricks to Mason 0.1.0-dev.52 ([#28](https://github.com/VeryGoodOpenSource/very_good_templates/pull/28))
 
-# 0.5.1
+## 0.5.1
 
 - feat: minify icon pngs ([#317](https://github.com/VeryGoodOpenSource/very_good_core/pull/317))
 - fix: templated project name for Release-production flavor ([#319](https://github.com/VeryGoodOpenSource/very_good_core/pull/319))
 
-# 0.5.0
+## 0.5.0
 
 - feat: change launchMode on Android to singleTask ([#297](https://github.com/VeryGoodOpenSource/very_good_core/pull/297))
 - feat: add macOS platform support ([#299](https://github.com/VeryGoodOpenSource/very_good_core/pull/299))
 - refactor: remove generator script ([#306](https://github.com/VeryGoodOpenSource/very_good_core/pull/306))
 - docs: update semantic commit link ([#313](https://github.com/VeryGoodOpenSource/very_good_core/pull/313))
 - fix: regenerate ios directory ([#310](https://github.com/VeryGoodOpenSource/very_good_core/pull/310))
 
-# 0.4.0
+## 0.4.0
 
 - feat!: bump min Dart SDK to 3.1.0
 - feat!: update to Flutter 3.13.2
@@ -103,95 +104,95 @@ mason make very_good_core -o ./output_folder
 - fix: very_good create flutter_app doesn't create .gradlew files
 - feat: upgrade to `very_good_analysis ^5.1.0`
 
-# 0.3.0
+## 0.3.0
 
 - feat!: update to Flutter 3.10.0
 - fix: use valid app label
 - feat: update bloc
 
-# 0.2.0
+## 0.2.0
 
 - feat!: bump min Dart SDK to 2.19.0
 
-# 0.1.15
+## 0.1.15
 
 - chore: support dart sdk 2.18.0
 - fix: rollback very_good_analysis to 3.1.0
 - test: include e2e test
 
-# 0.1.14
+## 0.1.14
 
 - feat: update workflows and add spellcheck
 - chore: remove explicit Flutter version constraint
 
-# 0.1.13
+## 0.1.13
 
 - feat: upgrade to `very_good_analysis ^4.0.0`
 
-# 0.1.12
+## 0.1.12
 
 - feat: upgrade bloc
   - bloc ^8.1.1
   - flutter_bloc ^8.1.2
   - bloc_test ^9.1.1
 - feat: upgrade to Flutter 3.7.1
 
-# 0.1.11
+## 0.1.11
 
 - feat: upgrade to Flutter 3.7.0
 
-# 0.1.10
+## 0.1.10
 
 - fix: pre_gen.dart recase extension fix
 
-# 0.1.9
+## 0.1.9
 
 - feat: upgrade to Flutter 3.3.10
 - feat: upgrade to mason v0.1.0-dev.40
 - fix: use correct description in index.html
 
-# 0.1.8
+## 0.1.8
 
 - docs: remove copyright header and license from generated code
 - feat: use flavor app name for the bundle name
 
-# 0.1.7
+## 0.1.7
 
 - feat: upgrade to Flutter 3.3.8
 - feat: add optional `applicationId`
 
-# 0.1.6
+## 0.1.6
 
 - feat: upgrade to Flutter 3.3.7
 
-# 0.1.5
+## 0.1.5
 
 - feat: upgrade to Flutter 3.3.6
 - fix: add support for `GlobalCupertinoLocalizations`
 
-# 0.1.4
+## 0.1.4
 
 - feat: fix dependabot config file
 
-# 0.1.3
+## 0.1.3
 
 - feat: upgrade to Flutter 3.3.3
 
-# 0.1.2
+## 0.1.2
 
 - feat: upgrade to Flutter 3.3.2
 - feat: upgrade to very_good_analysis ^3.1.0
 
-# 0.1.1
+## 0.1.1
 
 - feat: upgrade to Flutter 3.3.1
 - feat: upgrade to very_good_analysis ^3.0.2
 - feat: add dependabot integration
 
-# 0.1.0
+## 0.1.0
 
 - feat: upgrade to Flutter 3.3 and Dart 2.18
 
-# 0.0.1
+## 0.0.1
 
 - feat: initial release 🎉