Skip to content
This repository was archived by the owner on Dec 30, 2025. It is now read-only.

Commit b98d0fa

Browse files
numbatanumbata
committed
Extract danger reporting infrastructure into reusable workflows and gem
Moves reporting responsibility from consuming gems into ruby-grape-danger, establishing it as the authoritative Danger integration framework for Grape projects. Key changes: - Add RubyGrapeDanger::Reporter class for consistent danger report generation - Implement automatic reporting via at_exit hook in gem's Dangerfile - Add reusable GitHub Actions workflows (danger-run.yml, danger-comment.yml) with embedded script for posting/updating PR comments - Consuming gems now just import ruby-grape-danger and add their checks Benefits: ✅ DRY: Workflows defined once, reused by all projects ✅ Consistent: All projects use same reporting format and behavior ✅ Maintainable: Fix bugs in workflows once, all projects benefit ✅ Scalable: New danger checks automatically get reporting infrastructure ✅ Simple API: Projects only need `danger.import_dangerfile(gem: 'ruby-grape-danger')` Example usage: danger.import_dangerfile(gem: 'ruby-grape-danger') changelog.check! # Reporting happens automatically via at_exit hook Includes comprehensive specs for Reporter class with 13 test cases covering: - JSON report generation and formatting - Message type handling (strings, objects with .message method) - Edge cases (missing files, missing PR number, empty arrays, nil values) - Multiline content preservation
1 parent 0622a37 commit b98d0fa

7 files changed

Lines changed: 526 additions & 3 deletions

File tree

‎.github/workflows/danger-comment.yml‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
name: Danger Comment
2+
on:
3+
workflow_run:
4+
workflows: [Danger]
5+
types: [completed]
6+
workflow_call:
7+
8+
permissions:
9+
actions: read
10+
contents: read
11+
issues: write
12+
pull-requests: write
13+
14+
jobs:
15+
comment:
16+
runs-on: ubuntu-latest
17+
if: |
18+
(github.event_name == 'workflow_run' && github.event.workflow_run.event == 'pull_request')
19+
|| github.event_name == 'workflow_call'
20+
steps:
21+
- name: Checkout
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 1
25+
- name: Download Danger Report (workflow_run)
26+
if: github.event_name == 'workflow_run'
27+
uses: actions/download-artifact@v4
28+
continue-on-error: true
29+
with:
30+
name: danger-report
31+
run-id: ${{ github.event.workflow_run.id }}
32+
repository: ${{ github.event.workflow_run.repository.full_name }}
33+
github-token: ${{ secrets.GITHUB_TOKEN }}
34+
- name: Download Danger Report (reusable call)
35+
if: github.event_name == 'workflow_call'
36+
uses: actions/download-artifact@v4
37+
continue-on-error: true
38+
with:
39+
name: danger-report
40+
- name: Post or Update PR Comment
41+
uses: actions/github-script@v7
42+
with:
43+
script: |
44+
const fs = require('fs');
45+
46+
const hasItems = (arr) => Array.isArray(arr) && arr.length > 0;
47+
48+
let report;
49+
try {
50+
report = JSON.parse(fs.readFileSync('danger_report.json', 'utf8'));
51+
} catch (e) {
52+
console.log('No danger report found, skipping comment');
53+
return;
54+
}
55+
56+
if (!report.pr_number) {
57+
console.log('No PR number found in report, skipping comment');
58+
return;
59+
}
60+
61+
let body = '## Danger Report\n\n';
62+
63+
if (hasItems(report.errors)) {
64+
body += '### ❌ Errors\n';
65+
report.errors.forEach(e => body += `- ${e}\n`);
66+
body += '\n';
67+
}
68+
69+
if (hasItems(report.warnings)) {
70+
body += '### ⚠️ Warnings\n';
71+
report.warnings.forEach(w => body += `- ${w}\n`);
72+
body += '\n';
73+
}
74+
75+
if (hasItems(report.messages)) {
76+
body += '### ℹ️ Messages\n';
77+
report.messages.forEach(m => body += `- ${m}\n`);
78+
body += '\n';
79+
}
80+
81+
if (hasItems(report.markdowns)) {
82+
report.markdowns.forEach(md => body += `${md}\n\n`);
83+
}
84+
85+
if (!hasItems(report.errors) &&
86+
!hasItems(report.warnings) &&
87+
!hasItems(report.messages) &&
88+
!hasItems(report.markdowns)) {
89+
body += '✅ All checks passed!';
90+
}
91+
92+
const { data: comments } = await github.rest.issues.listComments({
93+
owner: context.repo.owner,
94+
repo: context.repo.repo,
95+
issue_number: report.pr_number
96+
});
97+
98+
const botComment = comments.find(c =>
99+
c.user.login === 'github-actions[bot]' &&
100+
c.body.includes('## Danger Report')
101+
);
102+
103+
if (botComment) {
104+
await github.rest.issues.updateComment({
105+
owner: context.repo.owner,
106+
repo: context.repo.repo,
107+
comment_id: botComment.id,
108+
body: body
109+
});
110+
} else {
111+
await github.rest.issues.createComment({
112+
owner: context.repo.owner,
113+
repo: context.repo.repo,
114+
issue_number: report.pr_number,
115+
body: body
116+
});
117+
}
118+
119+
// Fail if there are errors
120+
if (report.errors && report.errors.length > 0) {
121+
core.setFailed('Danger found errors');
122+
}

‎.github/workflows/danger-run.yml‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Danger
2+
on:
3+
pull_request:
4+
types: [ opened, reopened, edited, synchronize ]
5+
workflow_call:
6+
jobs:
7+
danger:
8+
name: Danger
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout
12+
uses: actions/checkout@v3
13+
with:
14+
fetch-depth: 0
15+
- name: Set up Ruby
16+
uses: ruby/setup-ruby@v1
17+
with:
18+
ruby-version: 2.7
19+
bundler-cache: true
20+
- name: Run Danger
21+
# Note: We use 'dry_run' mode intentionally as part of a two-workflow pattern.
22+
# The actual commenting on GitHub is handled by the danger-comment.yml workflow.
23+
run: bundle exec danger dry_run --verbose
24+
env:
25+
DANGER_REPORT_PATH: danger_report.json
26+
- name: Upload Danger Report
27+
if: always()
28+
uses: actions/upload-artifact@v4
29+
with:
30+
name: danger-report
31+
path: danger_report.json
32+
retention-days: 1
33+
if-no-files-found: ignore

‎Dangerfile‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,23 @@
11
# frozen_string_literal: true
22

3+
require 'ruby-grape-danger'
4+
require 'English'
5+
6+
# --------------------------------------------------------------------------------------------------------------------
7+
# Automatically export danger report when Dangerfile finishes
8+
# --------------------------------------------------------------------------------------------------------------------
9+
at_exit do
10+
next if $ERROR_INFO # Skip if an exception occurred
11+
12+
if defined?(status_report)
13+
reporter = RubyGrapeDanger::Reporter.new(status_report)
14+
reporter.export_json(
15+
ENV.fetch('DANGER_REPORT_PATH', nil),
16+
ENV.fetch('GITHUB_EVENT_PATH', nil)
17+
)
18+
end
19+
end
20+
321
# --------------------------------------------------------------------------------------------------------------------
422
# Has any changes happened inside the actual library code?
523
# --------------------------------------------------------------------------------------------------------------------

‎README.md‎

Lines changed: 93 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
## Table of Contents
88

99
- [Setup](#setup)
10-
- [Set DANGER_GITHUB_API_TOKEN in Travis-CI](#set-danger_github_api_token-in-travis-ci)
1110
- [Add Danger](#add-danger)
1211
- [Add Dangerfile](#add-dangerfile)
13-
- [Add Danger to Travis-CI](#add-danger-to-travis-ci)
12+
- [Add GitHub Actions Workflows](#add-github-actions-workflows)
1413
- [Commit via a Pull Request](#commit-via-a-pull-request)
14+
- [Reusable Workflows](#reusable-workflows)
1515
- [License](#license)
1616

1717
## Setup
@@ -28,16 +28,106 @@ gem 'ruby-grape-danger', require: false
2828

2929
### Add Dangerfile
3030

31-
Commit a `Dangerfile`, eg. [Grape's Dangerfile](https://github.com/ruby-grape/grape/blob/master/Dangerfile).
31+
Create a `Dangerfile` in your project's root that imports `ruby-grape-danger` and adds your project-specific checks:
3232

3333
```ruby
3434
danger.import_dangerfile(gem: 'ruby-grape-danger')
35+
36+
# Your project-specific danger checks
37+
changelog.check!
38+
toc.check!
39+
```
40+
41+
The `ruby-grape-danger` Dangerfile automatically handles:
42+
- Setting up the reporting infrastructure
43+
- Exporting the danger report via `at_exit` hook when the Dangerfile finishes
44+
- Consistent output format for the workflow
45+
46+
### Add GitHub Actions Workflows
47+
48+
Create `.github/workflows/danger.yml`:
49+
50+
```yaml
51+
name: Danger
52+
on:
53+
pull_request:
54+
types: [ opened, reopened, edited, synchronize ]
55+
workflow_call:
56+
57+
jobs:
58+
danger:
59+
uses: ruby-grape/ruby-grape-danger/.github/workflows/danger-run.yml@main
60+
```
61+
62+
Create `.github/workflows/danger-comment.yml`:
63+
64+
```yaml
65+
name: Danger Comment
66+
on:
67+
workflow_run:
68+
workflows: [Danger]
69+
types: [completed]
70+
workflow_call:
71+
72+
jobs:
73+
comment:
74+
uses: ruby-grape/ruby-grape-danger/.github/workflows/danger-comment.yml@main
3575
```
3676

3777
### Commit via a Pull Request
3878

3979
To test things out, make a dummy entry in `CHANGELOG.md` that doesn't match the standard format and make a pull request. Iterate until green.
4080

81+
## Reusable Workflows
82+
83+
This gem provides **reusable GitHub Actions workflows** that can be referenced by any Grape project to implement standardized Danger checks with consistent reporting.
84+
85+
### Architecture
86+
87+
The workflows are separated into two stages:
88+
89+
1. **danger-run.yml**: Executes Danger checks and generates a report
90+
- Runs `bundle exec danger dry_run` with your project's Dangerfile
91+
- Generates a JSON report of check results
92+
- Uploads the report as an artifact
93+
94+
2. **danger-comment.yml**: Posts/updates PR comments with results
95+
- Downloads the Danger report artifact
96+
- Formats and posts results as a PR comment
97+
- Updates existing comment on subsequent runs
98+
99+
### Benefits of Reusable Workflows
100+
101+
✅ **DRY**: Define workflows once in `ruby-grape-danger`, reuse everywhere
102+
✅ **Consistent**: All Grape projects use the same reporting format and behavior
103+
✅ **Maintainable**: Fix a bug in the workflows once, all projects benefit automatically
104+
✅ **Scalable**: Add new checks to any project's Dangerfile without touching workflows
105+
106+
### How It Works
107+
108+
When you reference the reusable workflows:
109+
110+
```yaml
111+
uses: ruby-grape/ruby-grape-danger/.github/workflows/danger-run.yml@main
112+
```
113+
114+
GitHub Actions:
115+
1. Checks out **your project's repository** (not ruby-grape-danger)
116+
2. Installs dependencies from **your Gemfile**
117+
3. Runs danger using **your Dangerfile**
118+
- Your Dangerfile imports `ruby-grape-danger`'s Dangerfile via `danger.import_dangerfile(gem: 'ruby-grape-danger')`
119+
- The imported Dangerfile registers an `at_exit` hook for automatic reporting
120+
- Runs your project-specific checks (added after the import)
121+
- When Dangerfile finishes, the `at_exit` hook automatically exports the report
122+
4. The report is uploaded as an artifact for the commenting workflow
123+
124+
Each project maintains its own Dangerfile with project-specific checks, while the `ruby-grape-danger` gem provides shared infrastructure for consistent reporting and workflow execution.
125+
126+
### Examples
127+
128+
- [danger-changelog](https://github.com/ruby-grape/danger-changelog) - Validates CHANGELOG format
129+
- [grape](https://github.com/ruby-grape/grape) - Multi-check danger implementation
130+
41131
## License
42132

43133
MIT License. See [LICENSE](LICENSE) for details.

‎lib/ruby-grape-danger.rb‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
require 'ruby-grape-danger/version'
2+
require 'ruby-grape-danger/reporter'
3+
4+
module RubyGrapeDanger
5+
end

‎lib/ruby-grape-danger/reporter.rb‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
require 'json'
2+
3+
module RubyGrapeDanger
4+
class Reporter
5+
def initialize(status_report)
6+
@status_report = status_report
7+
end
8+
9+
def export_json(report_path, event_path)
10+
return unless report_path && event_path && File.exist?(event_path)
11+
12+
event = JSON.parse(File.read(event_path))
13+
pr_number = event.dig('pull_request', 'number')
14+
return unless pr_number
15+
16+
report = build_report(pr_number)
17+
File.write(report_path, JSON.pretty_generate(report))
18+
end
19+
20+
private
21+
22+
def build_report(pr_number)
23+
{
24+
pr_number: pr_number,
25+
errors: to_messages(@status_report[:errors]),
26+
warnings: to_messages(@status_report[:warnings]),
27+
messages: to_messages(@status_report[:messages]),
28+
markdowns: to_messages(@status_report[:markdowns])
29+
}
30+
end
31+
32+
def to_messages(items)
33+
Array(items).map do |item|
34+
item.respond_to?(:message) ? item.message : item.to_s
35+
end
36+
end
37+
end
38+
end

0 commit comments

Comments
 (0)