OWASP / OWASP/owasp-java-encoder

Retire or modernize the legacy Maven site and reporting stack

Aperta
#96 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Java
Stelle
543
Fork
122
Merge medio
9h 9m
PR unite (30g)
1

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dal POM radice e dal branch gh-pages esaminato, quindi esegui mvn site e clean verify sulla toolchain supportata. Fai un inventario delle pagine generate, dei report, delle dipendenze, dei sorgenti/Javadocs allegati, dei metadati di release e della documentazione per i contributori. Il lavoro è completato quando esiste una decisione documentata di mantenere o ritirare, vengono preservate le destinazioni e i comportamenti utili e la gestione dei contenuti ospitati e dei reindirizzamenti è stata approvata dai maintainer.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
build-system, ci-cd, documentation
Tipo di issue
Refactoring
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Attiva
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.