Decouple build artifact naming from RFC "seriesInfo" metadata
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 48/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 活発
調査の方向性
Start with openid/fapi/build-all.py and the markdown2rfc container's make.sh entrypoint, which both derive output names from seriesInfo.value. Trace how build metadata and output names flow into HTML and XML generation, then check the openid/publication checks. Done means documents without a seriesInfo block build with OIDF naming, existing identifiers and artifacts remain intact, and rendered output has no unintended IETF metadata.
索引モデルが issue の本文から書いたものです。
説明
Problem
The FAPI build pipeline currently depends on the "seriesInfo.value" field to determine output filenames.
This dependency exists in two places:
- "openid/fapi/build-all.py" extracts the output basename from a "value = "..."" line.
- The "danielfett/markdown2rfc" container's "make.sh" entrypoint uses "grep -m1 value" for the same purpose.
This forces OpenID Foundation documents to include RFC-specific "seriesInfo" metadata solely to make the build succeed.
For example, FAPI 2.0 Implementation Advice currently declares "name = "Internet-Draft"", although it is not an IETF Internet-Draft.
Proposed changes
- Decouple output filename generation from "seriesInfo". Derive the document basename from the source filename and the draft revision from the document title or explicitly configured build metadata.
- Pass the output basename explicitly to the Markdown-to-HTML conversion pipeline, bypassing or updating the container entrypoint's reliance on "grep".
- Maintain backward compatibility for existing FAPI documents that currently use "seriesInfo.value".
- Ensure the generated HTML and XML do not incorrectly identify OIDF documents as IETF Internet-Drafts or Standards Track documents.
- Preserve the existing manifest, HTML filename normalization, and XML artifact generation.
Acceptance criteria
- Existing FAPI documents continue to build without changing their published document identifiers.
- A document without a "[seriesInfo]" block builds successfully.
- The output filename follows the OIDF specification naming conventions.
- The rendered HTML contains no unintended IETF Internet-Draft metadata or boilerplate.
- The generated artifacts pass the "openid/publication" checks.
References
- "OIDF Naming and Contents of Specifications" (https://openid.net/wg/resources/naming-and-contents-of-specifications/)
- "OIDF Publication Error Modes" (https://github.com/openid/publication/blob/main/ERROR-MODES.md)
- "FAPI build-all.py" (https://github.com/openid/fapi/blob/master/build-all.py)
- "markdown2rfc make.sh" (https://github.com/oauthstuff/markdown2rfc/blob/master/make.sh)
- "RFC 7991 §2.47" (https://www.rfc-editor.org/rfc/rfc7991#section-2.47)
- 主要言語
- HTML
- スター
- 5
- フォーク
- 3
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openid/fapi のほかの issue
-
component: FAPI 1: Advanced migrated-from-bitbucket priority: major type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
-
migrated-from-bitbucket priority: trivial type: bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 35/100
-
Add support for resource-server constrained grant status queries for asynchronous delivery use casesオープン
難易度 5/5 1週間以上 初心者へのやさしさ 8/100
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
似ている issue
-
The Recommended preset turns on Import Uno DSP, which only works with the Material theme対応中かも @agneszitte が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
unoplatform/uno.templates#2388 ·
メンテナーはふだん 1 日以内に返信
-
area:ci area:security phase:dev priority:p1 type:chore
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 83/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
BlackLabelHQ/SymphonyRecomp#146 ·