workflow-catalogue

A catalogue with shared EODH-related workflow definitions and the CI/CD pipelines that validate, register, and publish them.

Getting started

Create the environment:

make env

Run pre-commit hooks:

make pc

Validate all catalogue records:

make validate-catalogue

Adding a workflow or notebook

1. Create a feature branch from main
2. Choose the target collection directory under catalogue/ (e.g. catalogue/eodh-workflows-notebooks/)
3. Copy an existing record as a template:
   • Workflows: catalogue/eodh-workflows-notebooks/workflows/ndvi-workflow.json
   • Notebooks: catalogue/eodh-workflows-notebooks/notebooks/ndvi_calculation.json
4. Save your new file in the appropriate subdirectory. The filename must match the id field (e.g. my-workflow.json with "id": "my-workflow")
5. Set properties.type to "workflow" or "notebook"
6. Validate locally: make validate-catalogue
7. Push and open a PR targeting main — CI validates automatically
8. After review and merge, CD registers the record in the API under the collection derived from the directory name

See the full guide for field descriptions and examples.

Dev LOG

See the log of changes and experiment results. Best to view it via mkdocs serve command.

Guides

Read more here:

• Development env setup
• Contributing
• Adding records
• QA testing
• Makefile usage
• Running tests

Docs

To build project documentation run:

make docs

and then:

mkdocs serve