Elixir

A command-line tool for commenting dart analyze --format=machine $dir results to GitHub PullRequest.

Demo

Required

Dart SDK version >=2.15.0 <3.0.0

Usage

GitHub Action

name: "analyze"
on:
  pull_request:

jobs:
  dart:
    runs-on: ubuntu-latest
    steps:
      # https://github.com/actions/checkout
      - uses: actions/checkout@v3

      # https://github.com/dart-lang/setup-dart
      - uses: dart-lang/setup-dart@v1

      # https://github.com/blendthink/elixir
      - uses: blendthink/elixir@v2
        with:
          # (Optional) GITHUB_TOKEN or a `repo` scoped Personal Access Token (PAT).
          # Default: ${{ github.token }}
          token: ''

          # (Optional) Directory to run the `dart analyze`.
          # Default: ./
          dir: ''

CLI

This package uses Git internally.

If you are using GitHub Actions, you can skip steps 1.

1. Install Git

https://git-scm.com/book/en/v2/Getting-Started-Installing-Git

2. Active package

dart pub global activate elixir

3. Run package

cd {git-repository-path}
elixir run \
  --repo={repo} \
  --num={num} \
  --base={base} \
  --head={head} \
  --dir={dir}

How to contribute

You should follow our Code of Conduct.

See Contributor Guide for contributing conventions.

Contributors

_blendthink