這是 W3C WebAuthn 工作小組的儲存庫,負責制定「Web 驗證」規範草案。
gh-pages
分支中找到。若要為本規範做出實質貢獻,您必須滿足 CONTRIBUTING.md 中概述的要求。另外,在提交回饋之前,請熟悉我們當前的問題清單並查看郵件清單討論。
可以使用bikeshed
建立草稿的格式化 HTML(有關bikeshed
安裝的說明,請參閱下文):
$ bikeshed spec
您可能還想使用watch
功能在進行更改時自動重新生成:
$ bikeshed watch
請參閱 https://tabatkins.github.io/bikeshed/#installing 上的完整說明。
您需要安裝 Python 3.7 或更高版本。安裝 Python 3.7 或更高版本後,若要安裝 Bikeshed 本身,請執行下列命令:
pip3 install bikeshed && bikeshed update
完成後,Bikeshed 應該已安裝,並且bikeshed
命令應該可以在您的 shell 中運行。
每次推送到main
分支時,https://w3c.github.io/webauthn/ 都會從gh-pages
分支自動發布,使用https://github.com/w3c/webauthn/blob/main/.github/workflows / build-validate-publish.yml 用於配置自動發布行為。
要建立新的 WD 並將其上傳到 W3C 發布系統:
bikeshed update
bikeshed spec
bikeshed echidna --u USERNAME --p PASSWORD --d DECISION_URL
上面的命令將創建 HTML 和圖像的 tarball,並上傳到 Echidna(W3C 的自動發布系統)。該命令應返回一個url,透過該url您可以知道您是否成功發布草稿。也可以透過郵件清單存檔追蹤請求的狀態。您也可以使用 Echidna 文件中所述的 W3C API。請注意,在 Windows 上,這將給出有關無法刪除臨時檔案的錯誤,因為它正在被不同的進程使用。此錯誤是無害的;它發生在提交完成後。
如果透過此程序發布不成功,則可能是由於 Specbreus(規範合規性檢查器)造成的。 Echidna 自動執行 Specbreus,如果 Specbreus 回報任何錯誤,將拒絕發布。您可以透過 Pubrules 運行您的文檔,以了解您的文檔被拒絕的原因。您可以修改index.bs 檔案或index.html 檔案以確保合規性。
通常,您會發現 Pubrules 錯誤是由於 Bikeshed 或 Specbreus 中的錯誤造成的。如果是這樣,您將必須修改編譯的index.html檔案以繞過Echidna並使用手動程序進行發布。當您編輯 html 檔案以避免錯誤時,您還應該檢查以確保文件仍然正確呈現。
手動過程要求您先建立一個 tar 檔案。要建立 tar 文件,您需要先複製index.html 文件並將複製的文件重新命名為Overview.html。這是因為 Echidna 無法辨識index.html。然後您可以使用以下命令建立 tar 檔案:
tar -cvf WD.tar Overview.html image1 image2 image3
然後您可以執行以下命令curl來發佈到Echidna(在與您的tar檔案相同的目錄中使用該命令):
curl 'https://labs.w3.org/echidna/api/request' --user '<username>:<password>' -F "[email protected]" -F "decision=<decisionUrl>"
當您遇到困難時,請隨時聯繫您的主席或任何 W3C 工作人員。關於針鼴的整體資訊在這裡:https://github.com/w3c/echidna/wiki 和這裡 https://labs.w3.org/echidna/。