Publish IntelliJ Plugin Verifier Report

Publish IntelliJ Plugin Verifier report and a pull request comment.

Usage

Required Configuration

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/publish-intellij-plugin-verifier-report@v1.2.0
        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

      - uses: sczerwinski/publish-intellij-plugin-verifier-report@v1.2.0
        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
• dtinth/markdown-report-action