Github Actions Generator for Dart & Flutter Monorepos

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]_verify_and_test.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.

Tips

• You can exclude packages from the generation by changing the exclude variable. Just make sure it's formatted as an array of strings.
• You can exclude lines of code from coverage on the packages by adding a coverage_exclude section to the package's pubspec.yaml file.
• You can control the test coverage two ways:
  • The first priority is on the package's pubspec.yaml file by setting the minimum_coverage field.
  • The second priority if the minCoverage variable passed into the brick.
  • If neither is set, a default of 100% will be set.

Example pubspec.yaml

name: my_awesome_dart_package

dependencies:
  ...

coverage_exclude:
  - "**/*.g.dart"
  - "**/*.ignorethis"

minimum_coverage: 100

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"

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.