https://github.com/invertase/github-action-dart-analyzer

A GitHub action to run Dart analyzer with annotation support.
https://github.com/invertase/github-action-dart-analyzer

hacktoberfest

Last synced: over 1 year ago
JSON representation

A GitHub action to run Dart analyzer with annotation support.

• Host: GitHub
• URL: https://github.com/invertase/github-action-dart-analyzer
• Owner: invertase
• Created: 2022-01-11T20:05:04.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T17:13:21.000Z (about 2 years ago)
• Last Synced: 2025-03-30T17:11:32.196Z (over 1 year ago)
• Topics: hacktoberfest
• Language: TypeScript
• Homepage:
• Size: 452 KB
• Stars: 168
• Watchers: 6
• Forks: 10
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

          


  
⚒️ GitHub Action for Dart Analyzer

  A GitHub action to run Dart analyzer with annotation support.


 

   

 

License

---

## Usage

```yaml

name: "analyze"

on: # rebuild any PRs and main branch changes

  pull_request:

  push:

    branches:

      - main

jobs:

  dart: # make sure the action works on a clean machine without building

    runs-on: ubuntu-latest

    steps:

      - uses: actions/checkout@v2

      - uses: dart-lang/setup-dart@v1

      - uses: invertase/github-action-dart-analyzer@v1

        with:

          # (Optional) Treat info level issues as fatal.

          fatal-infos: false

          # (Optional) Treat warning level issues as fatal

          # (defaults to true).

          fatal-warnings: false

          # (Optional) Whether to add annotations to GitHub actions summary / PR

          # review files.

          # (defaults to true).

          annotate: true

          # (Optional) If set to true only annotations will be created and the

          # GitHub action itself will not fail on Dart analyzer problems. 

          # (defaults to false).

          annotate-only: false

          # (Optional) If set to true the GitHub action will run custom_lint

          # if it is found as dependency in the pubspec.yaml

          # (defaults to false).

          custom-lint: false

          # (Optional) The working directory to run the Dart analyzer in 

          # (defaults to `./`).

          working-directory: ./

```

## Screenshots

**Example annotation output in PR changes review**:

1) ![image](https://user-images.githubusercontent.com/5347038/149161220-dbd92743-2cdc-4083-b7f2-31ed9ca7f855.png)

2) ![image](https://user-images.githubusercontent.com/5347038/149161397-d6a72437-a15f-4dbb-a6b5-227bd11da210.png)

3) ![image](https://user-images.githubusercontent.com/5347038/149161493-66e2b7f6-177a-4daa-bb66-9d0a26ba391d.png)

**Example annotation output in check summary**:

![image](https://user-images.githubusercontent.com/5347038/149163192-e7f97894-cd1c-4892-92be-580f121a9aef.png)

**Example workflow logs output**:

![image](https://user-images.githubusercontent.com/5347038/149162346-573bf836-489f-458f-8501-60148d2104cd.png)

---



  

    

  

  


    Built and maintained by Invertase.