https://github.com/eddytheco/qmllint-action
Action that creates PR and review comments with qmllint warnings
https://github.com/eddytheco/qmllint-action
qml qmllint qt6
Last synced: 2 months ago
JSON representation
Action that creates PR and review comments with qmllint warnings
- Host: GitHub
- URL: https://github.com/eddytheco/qmllint-action
- Owner: EddyTheCo
- License: gpl-3.0
- Created: 2024-04-15T21:32:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-07T17:17:41.000Z (about 1 year ago)
- Last Synced: 2025-02-07T08:34:36.332Z (4 months ago)
- Topics: qml, qmllint, qt6
- Language: C++
- Homepage: https://eddytheco.github.io/qmllint-action/
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# qmllint-action
[TOC]
This action creates PR comments with the errors found by [qmllint](https://doc.qt.io/qt-6/qtqml-tooling-qmllint.html).
The action needs `pull-requests: write` permissions, the json qmllint output files and the PR number.
## Usage
### Inputs
```
- uses: EddyTheCo/qmllint-action/@v0.1.0
with:
# Absolute path to the json qmllint output files
jsondir:
# Pull request number the action will create the comment
pr_number: ${{ steps.getprn.outputs.prn }}
# Absolute path of the qmllint analized repo when qmllint was runned.
# This is used to get relative file paths to create reviews on qml files of the github repo.
repodir:
```
## Examples
The [examples](examples) folder will showcase the bot when someone does a PR to this repo.
One can add complicated qml errors to the example project and when one does a PR the bot will comment the QML errors.
## Contributing
We appreciate any contribution!
You can open an issue or request a feature.
You can open a PR to the `develop` branch and the CI/CD will take care of the rest.
Make sure to acknowledge your work, and ideas when contributing.