Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

export: Add --warning, update schema #1726

Merged
merged 6 commits into from
Jan 22, 2025
Merged

Conversation

victorlin
Copy link
Member

@victorlin victorlin commented Jan 17, 2025

Description of proposed changes

Add a new option augur export --warning which surfaces as meta.warning in the exported JSON.

Related issue(s)

Closes #1722

Checklist

Link to an issue with more discussion.
It's only used to set markdown_text, whose value can safely be used
outside of the with block.
Behavior and thus implementation is nearly identical to that of the
--description option.
Unlike --description, it makes sense to keep --warning short. Users may
find it easier to incorporate --warning into workflows if it allows a
single string instead of requiring a Markdown file.
@victorlin victorlin self-assigned this Jan 17, 2025
Added quotes to the test since those seem the most likely to stop
working upon future code changes.
Copy link
Member

@jameshadfield jameshadfield left a comment

Choose a reason for hiding this comment

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

Looks good - tested this in conjunction with the (new) Auspice using a few markdown files / strings, even including base64 images. Old auspice (pre auspice PR 1928) also works just fine with the extraneous meta.warning, as expected.

@victorlin victorlin merged commit 88063b7 into master Jan 22, 2025
26 of 36 checks passed
@victorlin victorlin deleted the victorlin/add-warning branch January 22, 2025 00:39
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.

export: Add warning text to output JSON and schema
2 participants