Skip to content

Document Zenodo download filename fallback and verify ZIP contents - #75

Open
beanbean9339 wants to merge 4 commits into
mainfrom
fix/issue-30-zenodo-download
Open

beanbean9339 wants to merge 4 commits into
mainfrom
fix/issue-30-zenodo-download

Conversation

@beanbean9339

Copy link
Copy Markdown
Collaborator

Closes #30

OpenCite already requests .zenodo.json for the standalone download and provides a Download ZIP (Both Files) option. This PR explains the browser/OS limitation and tells users to rename a standalone zenodo.json or extract the ZIP for the exact .zenodo.json filename. A regression test opens the generated ZIP and checks both metadata files, the validation report, their exact entry names, and contents.

Browser-specific standalone download naming cannot be guaranteed by an app; the ZIP preserves the filename internally.

Validation: npm run test (105 passed), npm run validate:metadata (passed), npm run build (passed).

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

No active review issues are identified for the filename guidance and ZIP export changes.

No open issues 🎉

What changed in this PR

Addresses #30 by documenting the standalone Zenodo filename limitation and verifying that the existing ZIP export preserves exact filenames and contents.

Changes:

  • Adds guidance to rename zenodo.json to .zenodo.json or download and extract the ZIP.
  • Exports the ZIP helper for a regression test covering both metadata files and the validation report.
File Description
tests/​services/​metadataZip.test.js Verifies exact ZIP entry names and contents for all three files.
src/​App.jsx Exports the ZIP helper and updates the filename guidance shown in the UI.
README.md Documents browser/OS filename limitations and rename or ZIP workarounds.

Review effort: Balanced

@beanbean9339 beanbean9339 added enhancement New feature or request question Further information is requested labels Nov 8, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request question Further information is requested

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Investigate .zenodo.json Download Behavior and Download-Both Option

2 participants