https://github.com/sczerwinski/publish-intellij-plugin-verifier-report
Publish IntelliJ Plugin Verifier report and a pull request comment.
https://github.com/sczerwinski/publish-intellij-plugin-verifier-report
action intellij-plugin
Last synced: 3 months ago
JSON representation
Publish IntelliJ Plugin Verifier report and a pull request comment.
- Host: GitHub
- URL: https://github.com/sczerwinski/publish-intellij-plugin-verifier-report
- Owner: sczerwinski
- License: apache-2.0
- Created: 2023-02-16T23:28:11.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-20T20:18:53.000Z (over 1 year ago)
- Last Synced: 2025-02-15T15:15:53.084Z (3 months ago)
- Topics: action, intellij-plugin
- Language: HTML
- Homepage:
- Size: 326 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Publish IntelliJ Plugin Verifier Report
Publish IntelliJ Plugin Verifier report and a pull request comment.
## Usage
### Required Configuration
```yml
jobs:
pluginVerifier:
runs-on: ubuntu-latest
# Required permissions:
permissions:
checks: write
pull-requests: write
steps:
# Run Plugin Verifier before publishing the report:
- run: ./gradlew runPluginVerifier
# Publish report even if Plugin Verifier has failed:
- if: ${{ always() }}
uses: sczerwinski/[email protected]
with:
plugin-id: "my.plugin.id"
plugin-version: "1.0.0"
```
**Notes:**
- The action must run with permissions `checks: write` and `pull-requests: write`.
- The plugin step should run **after** `./gradlew runPluginVerifier` is completed.
- Use `always()` to run the plugin even after `runPluginVerifier` fails.
- Parameters `plugin-id` and `plugin-version` are required.
### Optional Configuration
```yml
- uses: sczerwinski/[email protected]
with:
plugin-id: "my.plugin.id"
plugin-version: "1.0.0"
plugin-verifier-report-path: "${{ github.workspace }}/plugin/build/reports/pluginVerifier"
repo-token: "${{ my-secret-token }}"
```
## Options
| Input | Description | Required | Default Value |
|-------------------------------|------------------------------------------------|:--------:|--------------------------------------------------------|
| `plugin-id` | IntelliJ plugin ID | Y | |
| `plugin-version` | IntelliJ plugin version | Y | |
| `plugin-verifier-report-path` | Path to IntelliJ Plugin Verifier output report | N | `${{ github.workspace }}/build/reports/pluginVerifier` |
| `report-title` | Report title | N | Plugin Verification Results |
| `repo-token` | Repository token | N | `${{ github.token }}` |
## Credits
This action uses:
- [mshick/add-pr-comment](https://github.com/mshick/add-pr-comment)
- [dtinth/markdown-report-action](https://github.com/dtinth/markdown-report-action)