Repository navigation
Document Zenodo download filename fallback and verify ZIP contents - #75
Open
beanbean9339 wants to merge 4 commits into
Open
beanbean9339 wants to merge 4 commits into
beanbean9339 wants to merge 4 commits into
Conversation
There was a problem hiding this comment.
🟢 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.jsonto.zenodo.jsonor 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
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #30
OpenCite already requests
.zenodo.jsonfor the standalone download and provides a Download ZIP (Both Files) option. This PR explains the browser/OS limitation and tells users to rename a standalonezenodo.jsonor extract the ZIP for the exact.zenodo.jsonfilename. 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).