Getting Started

1. Configure the RefactorFirst Maven plugin

Add the plugin to your pom.xml:

<plugin> <groupId>org.hjug</groupId> <artifactId>refactorfirst-maven-plugin</artifactId> <version>LATEST</version> </plugin>

2. Set up report generation in your repository

3. Add your repository to this site

Once a report exists on your default branch, go toAdd Your Repo and enter your repository name. A pre-filled issue opens on this site's platform (GitHub, GitLab or Bitbucket) — submit it there and a CI job validates and adds your repository automatically.

How is my identity verified?

This site has no login and stores no credentials: your identity is captured by your platform (GitHub, GitLab or Bitbucket) as the author of the issue you create. The CI job then verifies — independently — that you actually have write access to the repository you submitted. This prevents abuse and keeps the listing trustworthy.

Any permissions or apps needed?

None. You never grant this site access to anything, and no OAuth apps or tokens are involved. You just need an account on the platform hosting the site you are using.

Troubleshooting

• Report doesn't render? Ensure .refactorfirst/refactor-first.json exists on your default branch.
• Changed default branch? Reports are looked up on the branch in the URL. If no branch is specified, the request falls back to main, then master.
• Submission fails? You need write access to the repository, and it must not already be listed.
• Submission is slow to appear? The site redeploys on a 10-minute schedule.