Github Actions Generator for Dart & Flutter Monorepos

Set Up

Run mason make github_actions_dart in the root of your monorepo. This will:

1. Scan your project for any pubspec.yaml files to grab their name and if they use Flutter. If will also find any path dependencies in the repo and create a small dependency tree.
2. Create a [PACKAGE_NAME].yaml file for each package under the .github/workflows directory that calls the corresponding Very Good Workflow. These will trigger on pull requests and pushes to the main/master branch, and will trigger if the current package has changes, or any of its path dependencies.
3. Creates a verify_github_actions.yaml that will enforce mason make github_actions_dart has been run to make sure all your packages are covered.

Optionally, it can also generate

• A spell check workflow from Very Good Workflows
• A semantic pull request workflow from Very Good Workflows
• A license checker workflows from Very Good Workflows
• A dependabot file

Updating

If new packages are added, you will need to update your actions workflows. A file (.github/update_github_actions.sh) is generated to easily update the workflow files. Before running it, you need to give permission to run it.

chmod u+x .github/update_github_actions.sh

Then run it

.github/update_github_actions.sh

Individual Package Specifications

You can override properties for individual packages. They should be added to a actions_config.yaml file in the same directory as the pubspec.yaml.

Setup 🧑‍💻

Ensure you have the mason_cli installed.

# 🎯 Activate from https://pub.dev
dart pub global activate mason_cli

# 🍺 Or install from https://brew.sh
brew tap felangel/mason
brew install mason

Installation ☁️

# Install locally
mason add github_actions_dart

# Install globally
mason add -g github_actions_dart

Usage 🚀

mason make github_actions_dart

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: "any"

3.0.0

• Workflow variables are now configured in the workflows_config.json file so it's easier to reference and change those values.
• Added support for Dart workflows. Learn more at https://dart.dev/tools/pub/workspaces

2.0.5

• Inject Flutter version variables into verify_github_actions.yaml

2.0.4

• Fixes fetching packages by installing Flutter instead of Dart in verify_github_actions.yaml

2.0.3

• Adds back Very Good CLI to the verify_github_actions.yaml as the current solution was not reliable.

2.0.2

• Make dart pub get command run in shell so it works on github actions.

2.0.1

• Removed installing Very Good CLI from verify_github_actions.yaml as it's not needed.
• verify_github_actions.yaml now manually fetches the workflow so that it still works if it's not included in your mason.yaml file (ie if it's installed globally).

2.0.0

• Breaking: This brick now searches for Flutter in the pubspec.lock file, not the pubspec.yaml. This means
  1. If you have not done a dart pub get in a particular package (ie it couldn't find a pubspec.lock file), the brick will run pub get in that file.
  2. It will now choose the Flutter builder if Flutter is used IN ANY transitive dependency. This means you won't have to add Flutter as a dependency just to force the correct workflow to run.
• Breaking: Removed the generateLicenseCheck variable. Now variables are configured in the actions_config.yaml for each individual package. See the README for details.
• Breaking: Rename dependabot.yml to dependabot.yaml for consistency with the other workflows.
• Breaking: Renames package check files to [PACKAGE_NAME].yaml from [PACKAGE_NAME]_verify_and_test.yaml.
• Added the ability to delete all other workflow files not controlled by this brick by setting the clearOldWorkflows to true.
• Added the mainJobName and licenseCheckJobName variables, which allows you to customize the name of the jobs generated.
• Bumped the default Flutter version to 3.24.4.

1.1.0

• Added a parameter to add license checking workflow to make sure your dependencies have appropriate licenses
• Upgraded default Flutter parameter to 3.22.1
• Fixed issue where dependencies with dependencies that needed Flutter weren't marked as needing Flutter
• Added cancel-in-progress: true to all workflows

1.0.0

• Breaking: Package specific configurations now are read from a actions_config.yaml file, not the package's pubspec. See README for details.
• Added generate_github_actions.sh file with configured options to quickly update files.
• Bumped Flutter version to 3.13.6
• Changed defaults for workflowRef, cspell config
• Added flags to prevent generating semantic pull request and spell checker

0.0.17

• Bumped default flutter version to 3.10.0
• Added workflowRef variable

0.0.16

• Added spellCheckConfig variable

0.0.15

• Fixed some issues ing 0.0.14

0.0.14

• Added spell check workflow
• Added concurrency helper
• Added semantic pull request job to verify and check

0.0.13

• Added the ability to generate a dependabot.yml file in addition to workflow files.

0.0.12

• Added an exclude paths variable, which can be used to exclude any pubspec.yaml files that match a particular path.
• Updated default flutter version to 3.3.0

0.0.10

• Fixed verify github actions workflow to include dartChannel variable

0.0.9

• Fixed top level packages not activating in Github actions
• Added variable for Dart SDK

0.0.8

• Fixed issue where packages in current directory wouldn't generate
• Bump default flutter version to 3.0.4

0.0.7

• Fix parsing issues for minimum coverage
• Bump default flutter version to 3.0.1

0.0.6

• Make minimum configurable by package from the pubspec

0.0.5

• Make verification Github action set flutter version and channel

0.0.4

• Added variables to control Flutter channel and version
• Update default Flutter to version 3.0.0!

0.0.3

• Make prehook ignore macos pubspecs

0.0.2

• Make flutter workflows specify flutter version

0.0.1

• Initial release! Generate Github Actions for your Dart Monorepos!

MIT License

Copyright (c) 2022 Marcus Twichel

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.