jsdocs are not getting published
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 4/5
- Tempo estimado
- 3-5 dias
- Facilidade para iniciantes
- 35/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Stack de tecnologia
- github-actions, javascript
- Domínio
- ci-cd, documentation
Direção de pesquisa
Comece comparando as etapas de publicação do jsdoc em ci/azure-pipelines.yml, nas linhas 218-283, com os workflows atuais do GitHub Actions. Verifique o código-fonte em docs/_jsdoc/tutorials/using-contractinterface.md e a saída correspondente do gh-pages; em seguida, confirme se a página publicada usa a versão atual do fabric-contract-api. Esclareça se o conteúdo duplicado de TUTORIAL.md deve ser mantido ou removido.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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?
- Linguagem predominante
- JavaScript
- Estrelas
- 262
- Forks
- 147
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de hyperledger/fabric-chaincode-node
-
Read/write batchingTalvez livre de novo @Vineet1101 assumiu há 250 dias e não há nenhum pull request aberto. Abertaenhancement help wanted
hyperledger/fabric-chaincode-node#453 · 7 comentários ·
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
hyperledger/fabric-chaincode-node#321 · 2 comentários ·
Todas as issues de hyperledger/fabric-chaincode-node
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 63/100
oskarrough/dodgethis#115 ·
Mantenedores costumam responder em até 1 dia
-
[Bug]: REST API URL starting with "http" but no scheme (e.g. httpbin.org/get) is not given an http:// prefixTalvez já em andamento @ItsDeadlyProgrammer assumiu hoje. Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
appsmithorg/appsmith#42471 · 1 comentário ·
Mantenedores costumam responder em até 2 dias
-
[External Plugin]: reelaryAbertaexternal-plugin requires-submitter-fixes
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
github/awesome-copilot#5396 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
chenasraf/nextcloud-forum#348 ·
-
needs-triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
melodic-software/claude-code-plugins#9619 ·
Mantenedores costumam responder em até 1 dia