Skip to content

Feature/publish reports#1

Merged
ascheman merged 6 commits intomainfrom
feature/publish-reports
Nov 16, 2025
Merged

Feature/publish reports#1
ascheman merged 6 commits intomainfrom
feature/publish-reports

Conversation

@ascheman
Copy link
Contributor

Cf. commits

ascheman and others added 4 commits November 15, 2025 11:31
Created generate_report.sh script to automate DependaBot PR report
generation and HTML conversion. The script:
- Generates public/dependabot-prs.adoc using export_maven_prs.py
- Converts all .adoc files in public/ to HTML using asciidoctor

Added public/index.adoc as landing page with links to all reports.

Updated .gitignore to exclude generated files in public/ while
keeping the index.adoc template under version control.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Modified export_maven_prs.py to use "Open Maven Dependabot PRs"
as the title when --dependabot flag is used, instead of the
generic "Open Maven PRs" title.

Added title parameter to export_to_asciidoc() function to support
customizable report titles.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Created publish-reports.yml workflow to automate report generation
and deployment:

- Triggers: push to any branch, PRs, manual dispatch, hourly cron
- Installs dependencies: Python, Ruby/asciidoctor, GitHub CLI
- Generates DependaBot PR reports using generate_report.sh
- Deploys to Netlify for branches/PRs (preview deployments)
- Deploys to GitHub Pages for main branch
- Scheduled runs (hourly) execute on main branch only

Required secrets: NETLIFY_AUTH_TOKEN, NETLIFY_SITE_ID

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
Enhanced the Netlify deployment workflow:

- Use meaningful aliases instead of commit hashes:
  * PRs deploy to: pr-{number} (e.g., pr-42)
  * Branches deploy to: sanitized branch name (e.g., feature-name)
- Display deployment URL in GitHub Actions summary
- Show deployment success status and alias name

This makes preview deployments easier to access and share.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@ascheman
Copy link
Contributor Author

If you want to have a look, @Bukama? There should be a preview on Netlify for branches/PRs. As soon as I merge it, there will be an hourly report on the respective GH pages.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces automated report generation and publishing infrastructure for Apache Maven repositories. The feature generates HTML reports from open pull requests (specifically Dependabot PRs) and publishes them via GitHub Pages and Netlify.

Key changes:

  • Added bash script to orchestrate report generation and AsciiDoc-to-HTML conversion
  • Enhanced Python export script to support customizable report titles based on PR filters
  • Created landing page documentation for published reports
  • Implemented dual-deployment GitHub Actions workflow (GitHub Pages for main, Netlify for branches/PRs)

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
scripts/generate_report.sh New bash script that generates Dependabot PR reports and converts AsciiDoc files to HTML
scripts/export_maven_prs.py Enhanced export function with configurable title parameter for filtered reports
public/index.adoc Landing page documentation listing available Maven reports
.gitignore Updated to exclude generated report files (adoc, html, csv) from version control
.github/workflows/publish-reports.yml Comprehensive workflow for automated report generation with scheduled runs, dual deployment to GitHub Pages and Netlify

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Changed pull-requests permission from read to write to allow
the Netlify action to post deployment URLs as PR comments.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <[email protected]>
@github-actions
Copy link

github-actions bot commented Nov 16, 2025

🚀 Deployed on https://pr-1--maven-simple-reports.netlify.app

Follow recommendations of CoPilot

Co-authored-by: Copilot <[email protected]>
@Bukama
Copy link
Collaborator

Bukama commented Nov 16, 2025

Looks great!

@Bukama
Copy link
Collaborator

Bukama commented Nov 16, 2025

Interesting thing

apache/maven-plugin-tools#951

this is listed as success, but has merge conflicts pending. But I think we could tackle this in a seperate issue and start with it as it - its really great

@ascheman ascheman merged commit 1e04a0e into main Nov 16, 2025
2 checks passed
@ascheman ascheman deleted the feature/publish-reports branch November 16, 2025 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants