flutter_github_workflow

A brick that creates a github workflow file using very good workflows. Supports: flutter_package, dart_package, semantic_pull_request and spell_check.

Installation 🚀️

To install run:

mason add flutter_github_workflow

To install globally run:

mason add -g flutter_github_workflow

How to use:

mason make flutter_github_workflow

Variables 🧩️

Outputs 📦️

Command:

mason make flutter_github_workflow --workflow_type dart_package --package_name auth_repository --min_coverage 100 --semantic_pr true --spell_check true

Output:

# auth_repository.yaml
name: auth_repository

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

on:
  pull_request:
    # To run this workflow only when certain files have changed, uncomment the
    # `paths` key below and replace the list of paths
    # paths:
    #   - "packages/auth_repository/**"
    #   - ".github/workflows/auth_repository.yaml"
    branches:
      - main

  push:
    # To run this workflow only when certain files have changed, uncomment the
    # `paths` key below and replace the list of paths
    # paths:
    #   - "packages/auth_repository/**"
    #   - ".github/workflows/auth_repository.yaml"
    branches:
      - main
jobs:
  # For further customization of this workflow, see: https://workflows.vgv.dev/docs/workflows/semantic_pull_request
  semantic-pull-request:
    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/semantic_pull_request.yml@v1
  # For further customization of this workflow, see: https://workflows.vgv.dev/docs/workflows/dart_package
  build:
    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/dart_package.yml@v1
    with:
      working_directory: packages/auth_repository
      dart_sdk: stable
      min_coverage: 100
  # For further customization of this workflow, see: https://workflows.vgv.dev/docs/workflows/spell_check
  spell-check:
    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/spell_check.yml@v1
    with:
      includes: |
        **/*.md
      modified_files_only: false

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 flutter_github_workflow

# Install globally
mason add -g flutter_github_workflow

Usage 🚀

mason make flutter_github_workflow

Variables ✨

Hooks 🪝

• ✅   Pre-Gen
• ❌   Post-Gen

Environment 🌎

mason: ">=0.1.0-dev.50 <0.1.0"

0.1.0

• chore: initial release 🎉️.

MIT License

Copyright (c) 2023 Elian Ortega

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.