OWASP / OWASP/owasp-java-encoder

Retire or modernize the legacy Maven site and reporting stack

Offen
#96 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
Java
Sterne
543
Forks
122
Ø Merge
9 Std. 9 Min.
Gemergte PRs (30 T.)
1

Beschreibung

Follow-up to #90 (reviewed at 31588e1). This tracks work intentionally kept separate from the modernization PR.

Current state

The review found mvn site failing in the legacy Site/Reflow/Doxia stack. The root POM retains Maven Site 3.4, Reflow tools 1.1.1, Velocity 1.7, Doxia Markdown 1.6, and older report plugins including FindBugs.

The reviewed gh-pages branch is a redirect to the OWASP project page, so a maintained source/site publishing requirement should be established before upgrading the entire stack.

Acceptance criteria

  • Inventory which generated pages and reports are still consumed, and make an explicit retain-versus-retire decision.
  • If retiring: remove unused site/report configuration and dependencies, preserve valuable documentation, and document the canonical OWASP/Javadoc destinations.
  • If retaining: update the stack coherently and demonstrate a clean mvn site build on the supported toolchain.
  • Review obsolete reports (including FindBugs) and either replace them with maintained analysis or explicitly retire them; coordinate with security CI to avoid redundant tooling.
  • Preserve attached sources/Javadocs, release metadata, existing useful links, and ordinary clean verify behavior.
  • Update contributor documentation so it no longer advertises a broken or unused workflow.

Do not delete hosted content or alter the live redirect without a separate maintainer-approved publishing step.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit dem Root-POM und dem geprüften gh-pages-Branch und führe anschließend mvn site und clean verify auf der unterstützten Toolchain aus. Erfasse generierte Seiten, Berichte, Abhängigkeiten, angehängte Quellen/Javadocs, Release-Metadaten und Dokumentation für Mitwirkende. Abgeschlossen ist die Aufgabe, wenn eine dokumentierte Entscheidung über Beibehalten oder Ausmustern vorliegt, nützliche Ziele und Verhaltensweisen erhalten bleiben und der Umgang mit gehosteten Inhalten und Weiterleitungen von Maintainer genehmigt wurde.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
build-system, ci-cd, documentation
Issue-Typ
Refactoring
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Aktiv
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.