hyperledger / hyperledger/fabric-chaincode-node

jsdocs are not getting published

未关闭
#422 4 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
JavaScript
星标
262
派生
149
平均合并
8 小时 32 分钟
30 天内合并 PR
2

描述

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?

贡献指南

打开贡献指南

调研方向

Start by comparing the jsdoc publishing steps in ci/azure-pipelines.yml at lines 218-283 with the current GitHub Actions workflows. Check the source under docs/_jsdoc/tutorials/using-contractinterface.md and the corresponding gh-pages output, then verify the published page uses the current fabric-contract-api version. Clarify whether the duplicated TUTORIAL.md content should remain or be removed.

由索引模型根据 Issue 内容生成。

评估

技术栈
github-actions, javascript
领域
ci-cd, documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
35/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。