Skip to content

Allow metadata in workflow spec.yaml - #231

Merged
atmorling merged 4 commits into
mainfrom
am/spec-metadata
Aug 17, 2026
Merged

Allow metadata in workflow spec.yaml#231
atmorling merged 4 commits into
mainfrom
am/spec-metadata

Conversation

@atmorling

Copy link
Copy Markdown
Collaborator

🌎 Summary

Closes #223

📦 Proposed Changes

Comment on lines +1084 to +1085
Extra fields beyond those declared here are allowed and retained, so
downstream tooling can build conventions on top of the spec.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Hopefully it's clear that this means we'll need an entirely separate conversation around the metadata convention/format for populating the ecoscope catalog

Comment on lines +1091 to +1094
license: str
repository: str | None = None
documentation: str | None = None
readme: str | None = None

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Per #77 we're intentionally not validating the string fields here as this would mean that, for example, a malformed url in the repository field would block the compilation process.

Comment on lines +1113 to +1116
metadata: Metadata | None = Field(
default=None,
description="Optional human-facing workflow metadata for catalog discovery.",
)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Metadata does not need to be provided, but if it is, it must have the minimum set of required fields

@atmorling
atmorling marked this pull request as ready for review August 12, 2026 13:46

@cisaacstern cisaacstern left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

lgtm thx!

@Yun-Wu Yun-Wu left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM! Thanks a lot Alex

@atmorling
atmorling merged commit 449fe49 into main Aug 17, 2026
29 checks passed
@atmorling
atmorling deleted the am/spec-metadata branch August 17, 2026 09:36
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.

Implement spec.yaml metadata

3 participants