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

doc: add examples for sign and verify #238

Merged
merged 18 commits into from
Jan 13, 2023

Conversation

patrickzheng200
Copy link
Contributor

@patrickzheng200 patrickzheng200 commented Jan 5, 2023

This PR adds examples for notation-go sign and verify including fully functional examples (can run in go playground) for local sign and local verify.

Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
@codecov-commenter
Copy link

codecov-commenter commented Jan 5, 2023

Codecov Report

Merging #238 (b7200da) into main (c90d521) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #238   +/-   ##
=======================================
  Coverage   73.31%   73.31%           
=======================================
  Files          23       23           
  Lines        1746     1746           
=======================================
  Hits         1280     1280           
  Misses        372      372           
  Partials       94       94           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@patrickzheng200 patrickzheng200 changed the title Feat: Added example for sign and verify Feat: Added examples for sign and verify Jan 5, 2023
Signed-off-by: Patrick Zheng <[email protected]>
@patrickzheng200 patrickzheng200 self-assigned this Jan 5, 2023
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

For local sign and verify, can we present a fully functional example so that customers can run it in the golang playground?

Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
example_localSign_test.go Outdated Show resolved Hide resolved
example_localSign_test.go Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
example_remoteSign_test.go Outdated Show resolved Hide resolved
example_remoteVerify_test.go Outdated Show resolved Hide resolved
example_remoteVerify_test.go Outdated Show resolved Hide resolved
example_remoteVerify_test.go Outdated Show resolved Hide resolved
example_remoteVerify_test.go Outdated Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Patrick Zheng <[email protected]>
example_localSign_test.go Outdated Show resolved Hide resolved
example_localSign_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
example_remoteSign_test.go Outdated Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
example_localVerify_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
example_localVerify_test.go Outdated Show resolved Hide resolved
example_remoteSign_test.go Outdated Show resolved Hide resolved
example_localVerify_test.go Outdated Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

example_localSign_test.go Outdated Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
example_localSign_test.go Show resolved Hide resolved
example_localSign_test.go Outdated Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

@shizhMSFT shizhMSFT changed the title Feat: Added examples for sign and verify doc: add examples for sign and verify Jan 11, 2023
Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM with one comment

example_localSign_test.go Outdated Show resolved Hide resolved
Signed-off-by: Patrick Zheng <[email protected]>
Copy link
Contributor

@shizhMSFT shizhMSFT left a comment

Choose a reason for hiding this comment

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

LGTM

@shizhMSFT shizhMSFT merged commit e11bfd8 into notaryproject:main Jan 13, 2023
@patrickzheng200 patrickzheng200 deleted the example branch January 13, 2023 10:22
priteshbandi pushed a commit to priteshbandi/notation-go that referenced this pull request Feb 1, 2023
This PR adds examples for notation-go sign and verify including fully
functional examples (can run in go playground) for local sign and local
verify.

Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Pritesh Bandi <[email protected]>
priteshbandi pushed a commit to priteshbandi/notation-go that referenced this pull request Feb 1, 2023
This PR adds examples for notation-go sign and verify including fully
functional examples (can run in go playground) for local sign and local
verify.

Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Pritesh Bandi <[email protected]>
priteshbandi pushed a commit to priteshbandi/notation-go that referenced this pull request Feb 1, 2023
This PR adds examples for notation-go sign and verify including fully
functional examples (can run in go playground) for local sign and local
verify.

Signed-off-by: Patrick Zheng <[email protected]>
Signed-off-by: Pritesh Bandi <[email protected]>
priteshbandi pushed a commit to priteshbandi/notation-go that referenced this pull request Feb 3, 2023
This PR adds examples for notation-go sign and verify including fully
functional examples (can run in go playground) for local sign and local
verify.

Signed-off-by: Patrick Zheng <[email protected]>
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.

None yet

6 participants