https://github.com/zebradevs/flutter-code-quality
A PR action for Flutter code quality
https://github.com/zebradevs/flutter-code-quality
actions dart flutter
Last synced: 4 months ago
JSON representation
A PR action for Flutter code quality
- Host: GitHub
- URL: https://github.com/zebradevs/flutter-code-quality
- Owner: ZebraDevs
- License: mit
- Created: 2024-06-25T14:47:01.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2026-02-18T09:40:15.000Z (4 months ago)
- Last Synced: 2026-02-18T14:12:16.992Z (4 months ago)
- Topics: actions, dart, flutter
- Language: TypeScript
- Homepage:
- Size: 3.42 MB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# flutter-code-quality
This action is designed to format and test Flutter repositories on pull requests. It helps ensure that your code meets the required quality standards.
### Usage
Follow the instructions below to integrate this action into your workflow.
```yml
jobs:
code-quality:
runs-on: ubuntu-latest
steps:
# Checkout branch
- uses: actions/checkout@v4
# Set up Flutter within the action
- uses: subosito/flutter-action@v2
with:
# See https://github.com/subosito/flutter-action
- uses: ZebraDevs/flutter-code-quality@v1.0.10
with:
# Token used for authentication.
token: ${{secrets.GITHUB_TOKEN}}
```
## Inputs
| Name | Description | Required | Default |
| ------------------- | ---------------------------------------------------------------------------------------------- | -------- | ------- |
| token | Token used for pushing fixes and commenting on PRs. | true | |
| run-tests | Whether tests should be run. | false | true |
| run-analysis | Whether static analysis should be run. | false | true |
| run-coverage | Whether code coverage should be run. | false | true |
| run-prev-coverage | Whether code coverage should be compared with the base branch - run-coverage must also be true | false | true |
| run-behind-by | Whether action should check if HEAD branch is behind base branch. | false | true |
| create-comment | Whether the action should comment the output status. | false | true |
| working-directory | Working directory to run the action in | false | "." |
| coverage-pass-score | Coverage passing percentage | false | "90" |
| test-command | Command used to run test suite. | false | "" |
By default, the `test-command` input is empty, and the action uses the following command to run tests and generate coverage:
```bash
flutter test --coverage --reporter json --coverage-path ${coverageDirectory}/lcov.info
```
If you provide a custom `test-command`, this default behavior is overridden. Note that the `${coverageDirectory}/lcov.info` path for coverage output is not automatically applied when using a custom command. You must ensure that your custom test command handles coverage generation and specifies the appropriate output path if required.
## Coverage
⚠️ To compare coverage against previous code, it is required that the code is checked out with `fetch-depth: 0`:
```yaml
- uses: actions/checkout@v4
with:
fetch-depth: 0
```
> During the action, coverage will be calculated, and lcov.info will be saved in temporary directory `.coverage`. Please refrain from using a top level directory with this path, as this could cause issues.
## Contributing
This project welcomes contributions. Please check out our [Contributing guide](CONTRIBUTING.md) to learn more on how to get started.
### License
This project is released under the [MIT License](./LICENSE).