Zenodo: github: inclui submódulos em arquivos zip do github

Criado em 27 mar. 2017  ·  5Comentários  ·  Fonte: zenodo/zenodo

Seria ótimo se o arquivo que é criado automaticamente quando eu crio uma versão no github incluísse quaisquer submódulos git que meu repo git pudesse conter. Eu acredito que, por exemplo, este pacote https://github.com/Kentzo/git-archive-all torna isso muito simples.

Feature request Needs investigation Pending GitHub

Comentários muito úteis

Por outro lado, algo assim poderia ser uma solução para os problemas de licenciamento? Ou isso significaria muito esforço de configuração no back-end?

Zenodo_submodules_suggestion

Acho que não incluir submódulos e não avisar os usuários sobre o fato de que arquivos importantes podem estar faltando pode ser um grande problema para a reprodutibilidade. Por exemplo, eu só percebi que o conteúdo do submódulo estava faltando em um de meus uploads, porque um revisor especialmente diligente realmente baixou a versão do Zenodo e tentou executar as simulações descritas em meu artigo.

Todos 5 comentários

Obrigado pela sugestão!

Uma coisa a considerar é se teríamos o direito de incluir todos os códigos de submódulos no arquivo junto com o código do usuário.

Com relação aos direitos: isso não seria um problema para repositórios onde todos os submódulos também estão no zenodo, então isso poderia ser habilitado pelo menos para casos restritos. Incluir os submódulos é, obviamente, essencial para que o código seja realmente reproduzível.

Como solução alternativa, pode-se usar um script de CI que gera releases que incluem o conteúdo dos submódulos relevantes como ativo. No entanto, devido ao # 1235, isso atualmente também não funciona.

Por exemplo, esta é a configuração que uso para o Travis CI:

before_deploy:
  - zip -r inamo-${TRAVIS_TAG}.zip . -x out\* plots\* .git\* regRefData/.git\*

deploy:
  provider: releases
  edge: true
  api_key:
    secure: "***"
  file: inamo-${TRAVIS_TAG}.zip
  release_notes_file: README.md
  tag_name: ${TRAVIS_TAG}
  name: InaMo ${TRAVIS_TAG}
  on:
    tags: true
  draft: true

Por outro lado, algo assim poderia ser uma solução para os problemas de licenciamento? Ou isso significaria muito esforço de configuração no back-end?

Zenodo_submodules_suggestion

Acho que não incluir submódulos e não avisar os usuários sobre o fato de que arquivos importantes podem estar faltando pode ser um grande problema para a reprodutibilidade. Por exemplo, eu só percebi que o conteúdo do submódulo estava faltando em um de meus uploads, porque um revisor especialmente diligente realmente baixou a versão do Zenodo e tentou executar as simulações descritas em meu artigo.

Não é razoável para o Zenodo saber ou tentar verificar quais submódulos o usuário pretende incluir ou tem direitos para, então, deixe-o ser um item de configuração em .zenodo.json

Esta página foi útil?
0 / 5 - 0 avaliações