Skip to content

docs(citation): registra o DOI do Zenodo e o ORCID que faltava - #559

Merged
MarkSant merged 1 commit into
mainfrom
docs/zenodo-doi
Sep 8, 2026
Merged

MarkSant merged 1 commit into
mainfrom
docs/zenodo-doi

Conversation

@MarkSant

@MarkSant MarkSant commented Sep 8, 2026

Copy link
Copy Markdown
Owner

Contexto

O release v7.0.0 foi publicado e o depósito no Zenodo cunhou o DOI. Este PR
fecha os dois passos que dependiam dele — e um terceiro que só ficou visível
depois que o registro existiu.

Registro: https://zenodo.org/records/22650405

Foram cunhados DOIS DOIs, e a distinção importa

DOI Resolve para
10.5281/zenodo.22650404 Concept — sempre a versão mais recente. É o que se cita por padrão.
10.5281/zenodo.22650405 Version — especificamente a 7.0.0.

O TODO no CITATION.cff previa um campo só. Os dois entram como
identifiers, e o concept vai também no doi: de topo — é ele que o widget
"Cite this repository" do GitHub exibe.

O ORCID que o registro publicado não tem

CITATION.cff trazia o ORCID da segunda autora (0000-0003-4591-4415).
.zenodo.json não. Como o registro do Zenodo é montado a partir do
.zenodo.json, o record publicado saiu sem o identificador dela — uma
divergência que era invisível até o depósito acontecer.

Este PR corrige o .zenodo.json, o que vale para as próximas versões.

⚠️ O registro já publicado precisa ser editado no próprio Zenodo. Os
metadados de um record são editáveis depois da publicação e o DOI não muda.
Isso não dá para fazer daqui.

date-released reprovava contra o schema

Estava sem aspas, então o YAML entregava um date onde o schema CFF 1.2.0 pede
string. Era o único ponto que reprovava o arquivo. Com aspas, valida limpo:

CITATION.cff VALIDA contra o schema CFF 1.2.0

(validado com jsonschema contra o schema.json oficial do
citation-file-format.)

Nos READMEs

Badge do DOI e uma tabela dizendo qual citar quando, nos dois idiomas — mais a
ressalva que já está nas notas do release: os números publicados vieram da
4.0.0, não desta.
Quem chega pelo DOI precisa ler isso antes de tentar
reproduzir, e o README era o único lugar de entrada que não dizia.

Verificação

  • CITATION.cff valida contra o schema CFF 1.2.0 (zero erros).
  • .zenodo.json continua JSON válido; os dois autores agora têm ORCID.
  • markdownlint na versão fixada pelo .pre-commit-config.yaml (v0.41.0)
    passa nos dois READMEs; mypy . passa no pre-push.
  • Só metadados e documentação — nenhum código tocado.

Fora deste PR, já verificado

O teste de aceitação que só era possível depois do Publish passou: os seis
pesos baixaram do release publicado para um diretório vazio, cada SHA-256
conferido, exit 0.

🤖 Generated with Claude Code

O deposito do v7.0.0 cunhou DOIS DOIs, e a distincao importa para quem
cita: o concept DOI (10.5281/zenodo.22650404) sempre resolve para a
versao mais recente, e o version DOI (10.5281/zenodo.22650405) fixa
especificamente a 7.0.0. O TODO no CITATION.cff previa um so campo,
entao os dois entram como `identifiers`, e o concept vai tambem no `doi`
de topo -- e ele que o widget "Cite this repository" do GitHub exibe.

Os READMEs ganham o badge e uma tabela dizendo qual DOI citar quando,
com a ressalva que ja esta nas notas do release: os numeros publicados
vieram da 4.0.0, nao desta. Quem chega pelo DOI precisa ler isso antes
de tentar reproduzir.

**O `.zenodo.json` nao tinha o ORCID da segunda autora, e o CITATION.cff
tinha.** A divergencia so aparece depois do deposito, porque o registro
e montado a partir do `.zenodo.json`: o record publicado saiu sem o
identificador dela. Corrigido aqui para as proximas versoes; o registro
ja publicado precisa ser editado no proprio Zenodo, onde os metadados
sao editaveis sem trocar o DOI.

`date-released` estava sem aspas, entao o YAML o entregava como `date` e
nao como string -- a unica coisa que reprovava o arquivo contra o schema
CFF 1.2.0. Com as aspas, valida limpo.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@MarkSant
MarkSant merged commit 051bd6e into main Sep 8, 2026
6 checks passed
@MarkSant
MarkSant deleted the docs/zenodo-doi branch September 8, 2026 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant