Dart Actions

A collection of reusable GitHub Actions workflows for Dart and Flutter projects. These workflows are designed to streamline CI/CD processes, enforce code quality standards, and automate publishing to pub.dev.

📋 Table of Contents

Available Workflows
Quick Start
Detailed Usage

Available Workflows

CI Workflow

File: .github/workflows/ci.yml

A comprehensive continuous integration workflow for Dart/Flutter projects using Melos for monorepo management.

Features

✅ Multi-package testing with Melos
🔍 Static code analysis with Dart Analyzer
🎯 Optional DCM (Dart Code Metrics) integration
🚀 Customizable Melos commands
⚡ Concurrent execution with auto-cancellation
📦 FVM (Flutter Version Management) support

Usage

name: CI

on:
  pull_request:
  push:
    branches: [main]

jobs:
  ci:
    uses: btwld/dart-actions/.github/workflows/ci.yml@main
    secrets:
      token: ${{ secrets.GITHUB_TOKEN }}
    with:
      flutter-version: "stable"
      run-dcm: true
      melos-commands: |
        melos run format:check
        melos run build_runner

Inputs

Input	Description	Required	Default
`flutter-version`	Flutter version to use (e.g., "stable", "3.19.0")	No	`"stable"`
`run-dcm`	Whether to run DCM analysis	No	`true`
`melos-commands`	Custom Melos commands to run (one per line)	No	`""`

Secrets

Secret	Description	Required
`token`	GitHub token for authentication (used for DCM)	Yes

What It Does

Checkout - Clones your repository
Setup Flutter - Installs specified Flutter version using FVM
Setup Melos - Installs and configures Melos
Bootstrap - Runs melos bootstrap to install dependencies
Custom Commands - Executes any custom Melos commands you specify
Analysis - Runs Dart analyzer on all packages
DCM - Runs Dart Code Metrics (if enabled)
Testing - Runs all Flutter and Dart tests

PR Title Check Workflow

File: .github/workflows/pr-title-check.yml

Validates pull request titles against Conventional Commits specification.

Features

📝 Enforces Conventional Commits format
💬 Automatic PR comments with helpful error messages
🔄 Auto-removes comments when title is fixed
🎨 Customizable messages

Usage

name: PR Title Check

on:
  pull_request:
    types: [opened, edited, synchronize, reopened]

jobs:
  pr-title-check:
    uses: btwld/dart-actions/.github/workflows/pr-title-check.yml@main

Advanced Usage

jobs:
  pr-title-check:
    uses: btwld/dart-actions/.github/workflows/pr-title-check.yml@main
    with:
      comment_header: "custom-pr-title-lint"
      comment_message: |
        ⚠️ Your PR title doesn't follow our guidelines!
        
        Please use: `type(scope): description`
        
        Examples:
        - feat(auth): add login functionality
        - fix(ui): resolve button alignment issue
        - docs: update README

Inputs

Input	Description	Required	Default
`comment_header`	Header used for the sticky PR comment	No	`"pr-title-lint-error"`
`comment_message`	Custom message shown when PR title is invalid	No	Default error message

Valid PR Title Examples

feat: add new feature
fix: resolve critical bug
docs: update documentation
style: format code
refactor: restructure component
test: add missing tests
chore: update dependencies
feat(auth)!: breaking change in authentication

Publish Workflow

File: .github/workflows/publish.yml

Automates publishing of Dart/Flutter packages to pub.dev using OIDC authentication.

Features

🚀 Automated publishing to pub.dev
🔐 Secure OIDC authentication (no API tokens needed)
📦 Multi-package support with parallel execution
✅ Pre-publish validation (analyze, test, dry-run)
🎯 Fail-safe mode (continues on individual package failures)

Usage

name: Publish Packages

on:
  release:
    types: [published]

jobs:
  publish:
    uses: btwld/dart-actions/.github/workflows/publish.yml@main
    with:
      packages_folder_path: "packages"
      packages: |
        my_package
        another_package
        third_package

Inputs

Input	Description	Required	Example
`packages_folder_path`	Path to the folder containing packages	Yes	`"packages"`
`packages`	List of package names to publish (one per line)	Yes	See example above

What It Does

For each package:

Checkout - Clones the repository
Setup - Installs Dart and Flutter
Dependencies - Runs flutter pub get
Analysis - Runs flutter analyze
Testing - Runs flutter test
Dry Run - Tests publishing with dart pub publish --dry-run
Publish - Publishes to pub.dev using OIDC authentication

Requirements

Your repository must be set up for OIDC publishing
The workflow requires id-token: write permission (already configured)
A "Production" environment should be configured in your repository settings

Quick Start

1. Add Workflows to Your Repository

Create a .github/workflows directory in your repository and add your workflow files:

# .github/workflows/ci.yml
name: CI

on:
  pull_request:
  push:
    branches: [main]

jobs:
  ci:
    uses: btwld/dart-actions/.github/workflows/ci.yml@main
    secrets:
      token: ${{ secrets.GITHUB_TOKEN }}

# .github/workflows/pr-check.yml
name: PR Checks

on:
  pull_request:
    types: [opened, edited, synchronize, reopened]

jobs:
  title-check:
    uses: btwld/dart-actions/.github/workflows/pr-title-check.yml@main

# .github/workflows/publish.yml
name: Publish

on:
  workflow_dispatch:
    inputs:
      packages:
        description: 'Package names (comma-separated)'
        required: true

jobs:
  publish:
    uses: btwld/dart-actions/.github/workflows/publish.yml@main
    with:
      packages_folder_path: "packages"
      packages: ${{ inputs.packages }}

2. Required Permissions

Ensure your workflows have the necessary permissions:

permissions:
  contents: read        # For checkout
  pull-requests: write  # For PR comments
  id-token: write      # For OIDC publishing

3. Repository Setup

For publishing to pub.dev:

Enable OIDC publishing in your pub.dev account
Configure a "Production" environment in your repository settings
Ensure your packages have proper version numbers and changelogs

Detailed Usage

CI Workflow Examples

Basic Monorepo Setup

jobs:
  ci:
    uses: btwld/dart-actions/.github/workflows/ci.yml@main
    secrets:
      token: ${{ secrets.GITHUB_TOKEN }}

With Custom Flutter Version

jobs:
  ci:
    uses: btwld/dart-actions/.github/workflows/ci.yml@main
    secrets:
      token: ${{ secrets.GITHUB_TOKEN }}
    with:
      flutter-version: "3.19.0"

With Build Runner and Code Generation

jobs:
  ci:
    uses: btwld/dart-actions/.github/workflows/ci.yml@main
    secrets:
      token: ${{ secrets.GITHUB_TOKEN }}
    with:
      melos-commands: |
        melos run build_runner
        melos run format:check

Without DCM

jobs:
  ci:
    uses: btwld/dart-actions/.github/workflows/ci.yml@main
    secrets:
      token: ${{ secrets.GITHUB_TOKEN }}
    with:
      run-dcm: false

Publish Workflow Examples

Manual Publishing via Workflow Dispatch

name: Publish Packages

on:
  workflow_dispatch:
    inputs:
      packages:
        description: 'Package names to publish'
        required: true
        type: string

jobs:
  publish:
    uses: btwld/dart-actions/.github/workflows/publish.yml@main
    with:
      packages_folder_path: "packages"
      packages: ${{ inputs.packages }}

Automatic Publishing on Release

name: Publish on Release

on:
  release:
    types: [published]

jobs:
  publish:
    uses: btwld/dart-actions/.github/workflows/publish.yml@main
    with:
      packages_folder_path: "packages"
      packages: |
        core_package
        utils_package
        ui_package

Additional Resources

Coverage Comment Action - Automated code coverage analysis and PR comments
Conventional Commits - Commit message specification
Melos - Tool for managing Dart/Flutter monorepos
OIDC Publishing - Secure package publishing

Contributing

When contributing to these workflows:

Ensure PR titles follow Conventional Commits
Test workflow changes thoroughly
Update documentation for any new features
Maintain backward compatibility when possible

License

See LICENSE file for details.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Dart Actions

📋 Table of Contents

Available Workflows

CI Workflow

Features

Usage

Inputs

Secrets

What It Does

PR Title Check Workflow

Features

Usage

Advanced Usage

Inputs

Valid PR Title Examples

Publish Workflow

Features

Usage

Inputs

What It Does

Requirements

Quick Start

1. Add Workflows to Your Repository

2. Required Permissions

3. Repository Setup

Detailed Usage

CI Workflow Examples

Basic Monorepo Setup

With Custom Flutter Version

With Build Runner and Code Generation

Without DCM

Publish Workflow Examples

Manual Publishing via Workflow Dispatch

Automatic Publishing on Release

Additional Resources

Contributing

License

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

Dart Actions

📋 Table of Contents

Available Workflows

CI Workflow

Features

Usage

Inputs

Secrets

What It Does

PR Title Check Workflow

Features

Usage

Advanced Usage

Inputs

Valid PR Title Examples

Publish Workflow

Features

Usage

Inputs

What It Does

Requirements

Quick Start

1. Add Workflows to Your Repository

2. Required Permissions

3. Repository Setup

Detailed Usage

CI Workflow Examples

Basic Monorepo Setup

With Custom Flutter Version

With Build Runner and Code Generation

Without DCM

Publish Workflow Examples

Manual Publishing via Workflow Dispatch

Automatic Publishing on Release

Additional Resources

Contributing

License