danger-pr-comment 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bed333a43c4c6883fbeea22eb24a5b1e7f92a3232fc446dfe0103b044c7b7579
+  data.tar.gz: 10e13269a7c517aa0f6539c728f5e6428960e1200e2577f4e58bdfa049f76d08
+SHA512:
+  metadata.gz: bf4f9f6a348f7ab8bcd42f5827a9c018e4a75fa12f3606613363bb6dfbc1983f9d8e9a1b4db36a06ece3f1bd4d5b232acf867d6f01699a31f7e56358cfa558a5
+  data.tar.gz: 15634bc538e51a3c634839bc36efb31fd5f37c960e7e97cc8c353ca7a55d1fdb5b52b04eb2048326303e27a573eff34dcf10578715e9a2b31b278acf6ddd53f9

data/Dangerfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'danger-pr-comment'
+require 'English'
+
+# Shared Dangerfile to export a JSON report for the danger-pr-comment workflows.
+dangerfile_instance = self if defined?(Danger::Dangerfile) && is_a?(Danger::Dangerfile)
+at_exit do
+  # Only skip if there's an actual exception (not SystemExit from danger calling exit)
+  next if $ERROR_INFO && !$ERROR_INFO.is_a?(SystemExit)
+  next unless dangerfile_instance
+
+  reporter = DangerPrComment::Reporter.new(dangerfile_instance.status_report)
+  reporter.export_json(
+    ENV.fetch('DANGER_REPORT_PATH', nil),
+    ENV.fetch('GITHUB_EVENT_PATH', nil)
+  )
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Andrei Subbota
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# Danger PR Comment
+
+Reusable GitHub Actions workflows for running Danger and posting a PR comment from a JSON report.
+
+## Usage
+
+### Quick Install
+
+From your repository root:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/numbata/danger-pr-comment/main/scripts/install-workflows.sh | bash
+```
+
+Use `--force` to overwrite existing workflow files. To target a specific directory:
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/numbata/danger-pr-comment/main/scripts/install-workflows.sh | bash -s -- --root /path/to/repo
+```
+
+### Manual Setup
+
+Create `.github/workflows/danger.yml` in your repository:
+
+```yaml
+name: Danger
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+jobs:
+  danger:
+    uses: numbata/danger-pr-comment/.github/workflows/danger-run.yml@main
+    secrets: inherit
+```
+
+Create `.github/workflows/danger-comment.yml` in your repository:
+
+```yaml
+name: Danger Comment
+on:
+  workflow_run:
+    workflows: [Danger]
+    types: [completed]
+
+jobs:
+  comment:
+    uses: numbata/danger-pr-comment/.github/workflows/danger-comment.yml@main
+    secrets: inherit
+```
+
+## Requirements
+
+- Your repository must run `bundle exec danger` successfully.
+- Your Dangerfile must write a JSON report to `ENV['DANGER_REPORT_PATH']` (for example, via a custom `at_exit` hook or a shared Dangerfile).
+- The `Danger Comment` workflow needs `actions: read` and `issues: write` permissions to download artifacts and post comments.
+
+### Dangerfile report example
+
+If you want a shared Dangerfile, add the gem and import it:
+
+```ruby
+# Gemfile
+gem 'danger-pr-comment', require: false
+```
+
+```ruby
+# Dangerfile
+# Import danger-pr-comment for automatic danger report export
+danger.import_dangerfile(gem: 'danger-pr-comment')
+```
+
+Or add this to your project's `Dangerfile` (or a shared Dangerfile) to emit the JSON report yourself:
+
+```ruby
+# Dangerfile
+require 'json'
+require 'English'
+
+dangerfile_instance = self if defined?(Danger::Dangerfile) && is_a?(Danger::Dangerfile)
+at_exit do
+  next if $ERROR_INFO && !$ERROR_INFO.is_a?(SystemExit)
+  next unless dangerfile_instance
+
+  report_path = ENV.fetch('DANGER_REPORT_PATH', nil)
+  event_path = ENV.fetch('GITHUB_EVENT_PATH', nil)
+  next unless report_path && event_path && File.exist?(event_path)
+
+  event = JSON.parse(File.read(event_path))
+  pr_number = event.dig('pull_request', 'number')
+  next unless pr_number
+
+  to_messages = lambda do |items|
+    Array(items).map { |item| item.respond_to?(:message) ? item.message : item.to_s }
+  end
+
+  report = {
+    pr_number: pr_number,
+    errors: to_messages.call(dangerfile_instance.status_report[:errors]),
+    warnings: to_messages.call(dangerfile_instance.status_report[:warnings]),
+    messages: to_messages.call(dangerfile_instance.status_report[:messages]),
+    markdowns: to_messages.call(dangerfile_instance.status_report[:markdowns])
+  }
+
+  File.write(report_path, JSON.pretty_generate(report))
+end
+```
+
+## Inputs
+
+`danger-run.yml` inputs:
+
+- `ruby-version`: Ruby version for `ruby/setup-ruby`. Leave empty to use `.ruby-version`/`.tool-versions`.
+- `bundler-cache`: Enable Bundler caching (default `true`).
+- `danger-args`: Arguments passed to `bundle exec danger` (default `dry_run`).
+- `report-artifact-name`: Artifact name for the report (default `danger-report`).
+- `report-file`: Report filename (default `danger-report.json`).
+
+`danger-comment.yml` inputs:
+
+- `report-artifact-name`: Artifact name to download (default `danger-report`).
+- `report-file`: Report filename inside the artifact (default `danger-report.json`).
+- `comment-title`: Heading for the PR comment (default `Danger Report`).
+- `comment-marker`: Marker string used to update the comment (default `<!-- danger-report -->`).
+
+## License
+
+MIT License. See [LICENSE](LICENSE.txt) for details.

data/lib/danger-pr-comment/reporter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module DangerPrComment
+  class Reporter
+    def initialize(status_report)
+      @status_report = status_report
+    end
+
+    def export_json(report_path, event_path)
+      return unless report_path && event_path && File.exist?(event_path)
+
+      event = JSON.parse(File.read(event_path))
+      pr_number = event.dig('pull_request', 'number')
+      return unless pr_number
+
+      report = build_report(pr_number)
+      File.write(report_path, JSON.pretty_generate(report))
+    end
+
+    private
+
+    def build_report(pr_number)
+      {
+        pr_number: pr_number,
+        errors: to_messages(@status_report[:errors]),
+        warnings: to_messages(@status_report[:warnings]),
+        messages: to_messages(@status_report[:messages]),
+        markdowns: to_messages(@status_report[:markdowns])
+      }
+    end
+
+    def to_messages(items)
+      Array(items).map do |item|
+        item.respond_to?(:message) ? item.message : item.to_s
+      end
+    end
+  end
+end

data/lib/danger-pr-comment/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DangerPrComment
+  VERSION = '0.1.0'
+end

data/lib/danger-pr-comment.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'danger-pr-comment/reporter'
+require 'danger-pr-comment/version'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: danger-pr-comment
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrei Subbota
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+description: Shared Dangerfile that exports a JSON report for posting Danger results
+  as a PR comment.
+email:
+- numbata@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Dangerfile
+- LICENSE.txt
+- README.md
+- lib/danger-pr-comment.rb
+- lib/danger-pr-comment/reporter.rb
+- lib/danger-pr-comment/version.rb
+homepage: https://github.com/numbata/danger-pr-comment
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.8
+specification_version: 4
+summary: Reusable workflows and shared Dangerfile for PR comment reporting.
+test_files: []