๐ Ensure your metadata is ready for archiving!
This GitHub Action validates your .zenodo.json file against the official Zenodo schema. No more broken uploads or missing creator names! We've vendored the schema ๐ฆ here, and also allow you to provide your own. โ๏ธ
Add this sparkle to your .github/workflows/validate.yml:
jobs:
validate:
runs-on: ubuntu-latest
steps:
- name: ๐ฅ Checkout code
uses: actions/checkout@v6
- name: ๐ก๏ธ Validate Zenodo Metadata
uses: vsoch/zenodo-validator@main
with:
path: '.zenodo.json'...for the rebels ๐ธ
Want to check your JSON before you even commit? Build the container and run it:
# ๐๏ธ Build the magic box
docker build -t zenodo-validator .
# ๐ช Run the spell
docker run --rm \
-v $(pwd):/github/workspace \
-e GITHUB_WORKSPACE=/github/workspace \
-e INPUT_PATH=.zenodo.json \
-e INPUT_SCHEMA_PATH=/schema.json \
-e INPUT_ERROR_FORMAT=text \
zenodo-validatorThe above also works with:
make
make validateAnd you can also use the image provided: ghcr.io/vsoch/zenodo-validator.
| Input | Description | Default |
|---|---|---|
path ๐ |
Where is your .zenodo.json? |
.zenodo.json |
error_format ๐จ |
text, json, or pretty-json |
text |
DevTools is distributed under the terms of the MIT license. All new contributions must be made under this license.
See LICENSE, COPYRIGHT, and NOTICE for details.
SPDX-License-Identifier: (MIT)
LLNL-CODE- 842614
MIT. Go forth and do science! ๐ฌ๐งฌ๐ฅ
Maintained by @vsoch ๐
