jsdocs are not getting published
還沒有人認領這個 Issue。
評估
- 難度
- 4/5
- 預估耗時
- 3-5 天
- 新手友好度
- 35/100
- Issue 類型
- 文件
- 描述清晰度
- 基本清楚
- 活躍度
- 停滯
- 技術堆疊
- github-actions, javascript
- 領域
- ci-cd, documentation
研究方向
首先，將 ci/azure-pipelines.yml 第 218-283 行中的 jsdoc 發佈步驟與目前的 GitHub Actions 工作流程進行比較。檢查 docs/_jsdoc/tutorials/using-contractinterface.md 中的原始碼以及對應的 gh-pages 輸出，然後確認已發佈的頁面使用目前版本的 fabric-contract-api。釐清是否應保留或移除重複的 TUTORIAL.md 內容。
由索引模型根據 Issue 內容生成。
描述
The jsdocs are no longer getting published.
For example the source file:
https://github.com/hyperledger/fabric-chaincode-node/blob/main/docs/_jsdoc/tutorials/using-contractinterface.md
Should get pushed to gh-pages branch here:
https://github.com/hyperledger/fabric-chaincode-node/blob/gh-pages/main/api/tutorial-using-contractinterface.html
Which then gets rendered here:
https://hyperledger.github.io/fabric-chaincode-node/main/api/tutorial-using-contractinterface.html
Look at the "fabric-contract-api" version in the above pages, you'll see the first link references 2.5.0 while the latter links still reference the outdated 2.4.1.
It looks like the jsdocs used to get published in the Azure Pipelines job at:
https://github.com/hyperledger/fabric-chaincode-node/blob/main/ci/azure-pipelines.yml#L218-L283
However, when Azure Pipelines was replaced by GitHub Actions, it looks like the jsdoc job did not get migrated over.
@mbwhite @bestbeforetoday I assume we should still be publishing the jsdocs as part of the GitHub Actions? What trigger would be appropriate?
Also, I'm a little confused because the tutorial https://github.com/hyperledger/fabric-chaincode-node/blob/main/TUTORIAL.md looks like a copy paste of https://github.com/hyperledger/fabric-chaincode-node/blob/main/docs/_jsdoc/tutorials/using-contractinterface.md. Should one of them be removed?
- 主要語言
- JavaScript
- 星號
- 262
- 分支
- 146
- PR 合併指標
- 30 天內沒有已合併 PR
環境準備
- 沒有 Dockerfile 或 Docker Compose 檔案
- 沒有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 Issue 編號。
hyperledger/fabric-chaincode-node 的其他 Issue
-
Read/write batching可能重新可做 @Vineet1101 於 260 天前認領，目前沒有進行中的 PR。 未關閉enhancement help wanted
hyperledger/fabric-chaincode-node#453 · 7 則留言 ·
-
難度 5/5 一週以上 新手友好度 25/100
hyperledger/fabric-chaincode-node#321 · 2 則留言 ·
查看 hyperledger/fabric-chaincode-node 的全部 Issue
相似的 Issue
-
bug confirmed js v6
難度 2/5 1-3 小時 新手友好度 85/100
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 72/100
維護者通常 1 天內回覆
-
BUG
難度 1/5 1-3 小時 新手友好度 90/100
linuxmint/cinnamon-spices-applets#9223 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 82/100
nopSolutions/nopCommerce#8440 ·
維護者通常 1 天內回覆
-
follow-up
難度 2/5 1-3 小時 新手友好度 75/100
維護者通常 1 天內回覆