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

Add YAML tags to match the support indicated in the documentation #1852

Merged
merged 1 commit into from
Nov 28, 2023

Conversation

nkreiger
Copy link
Contributor

Summary

Support is indicated for YAML, and the code attempts to do yaml first, however, based on the tags, only JSON is supported.

Release Note

(fix) add yaml tag

Documentation

No

Add yaml tags

Signed-off-by: Noah Kreiger <[email protected]>
@nkreiger nkreiger requested a review from a team as a code owner November 26, 2023 16:11
Copy link

codecov bot commented Nov 26, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (0394bf7) 66.33% compared to head (4a6d0ae) 66.33%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1852   +/-   ##
=======================================
  Coverage   66.33%   66.33%           
=======================================
  Files          90       90           
  Lines        9060     9060           
=======================================
  Hits         6010     6010           
  Misses       2313     2313           
  Partials      737      737           
Flag Coverage Δ
e2etests 47.93% <ø> (ø)
unittests 47.29% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@bobcallaway bobcallaway left a comment

Choose a reason for hiding this comment

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

the change is fine, but I can't seem to find any references to this in our documentation. Could you share a pointer?

@nkreiger
Copy link
Contributor Author

the change is fine, but I can't seem to find any references to this in our documentation. Could you share a pointer?

@bobcallaway

https://docs.sigstore.dev/logging/sharding/

specifically:

- treeID: $CURRENT_TREE_ID
  treeLength: $CURRENT_SHARD_LENGTH

Is what I was following when I encountered this

@bobcallaway
Copy link
Member

ah, ok. We don't ever marshal this struct directly as YAML, so I think this fix is just effectively a documentation improvement IIUC

@bobcallaway bobcallaway merged commit fb05e16 into sigstore:main Nov 28, 2023
14 checks passed
@github-actions github-actions bot added this to the v1.2.2 milestone Nov 28, 2023
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.

2 participants