OWASP / OWASP/owasp-java-encoder

Retire or modernize the legacy Maven site and reporting stack

オープン
#96 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement
主要言語
Java
スター
543
フォーク
122
平均マージ
9時間 9分
マージ済み PR(30日)
1

説明

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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ルート POM とレビュー済みの gh-pages ブランチから始め、次にサポート対象のツールチェーンで mvn site と clean verify を実行します。生成されたページ、レポート、依存関係、添付されたソース/Javadocs、リリースメタデータ、コントリビューター向けドキュメントを洗い出します。完了条件は、保持または廃止の判断が文書化され、有用な宛先と動作が維持され、ホストされたコンテンツとリダイレクトの扱いがメンテナーによって承認されていることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
build-system, ci-cd, documentation
issue の種類
リファクタリング
難易度
5/5
見積もり時間
1週間以上
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
35/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。