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

Examples were shown for experimental feature #645

Closed
yizha1 opened this issue Apr 25, 2023 · 1 comment · Fixed by #650
Closed

Examples were shown for experimental feature #645

yizha1 opened this issue Apr 25, 2023 · 1 comment · Fixed by #650
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@yizha1
Copy link
Contributor

yizha1 commented Apr 25, 2023

What is the areas you experience the issue in?

Notation CLI

What is not working as expected?

Examples were shown for experimental features when the NOTATION_EXPERIMENTAL=1 was not set.

notation sign -h

Example - [Experimental] Sign an OCI artifact referenced in an OCI layout
  notation sign --oci-layout "<oci_layout_path>@<digest>"

Example - [Experimental] Sign an OCI artifact identified by a tag and referenced in an OCI layout
  notation sign --oci-layout "<oci_layout_path>:<tag>"

Example - [Experimental] Sign an OCI artifact and use OCI artifact manifest to store the signature:
  notation sign --signature-manifest artifact <registry>/<repository>@<digest>

notation verify -h

Example - [Experimental] Verify a signature on an OCI artifact referenced in an OCI layout using trust policy statement specified by scope.
  notation verify --oci-layout <registry>/<repository>@<digest> --scope <trust_policy_scope>

Example - [Experimental] Verify a signature on an OCI artifact identified by a tag and referenced in an OCI layout using trust policy statement specified by scope.
  notation verify --oci-layout <registry>/<repository>:<tag> --scope <trust_policy_scope>

What did you expect to happen?

Examples should not be shown for experimental features unless the NOTATION_EXPERIMENTAL=1 was set.

How can we reproduce it?

Steps:

unset NOTATION_EXPERIMENTAL
notation sign -h
notation verify -h

Check the examples from the output

Describe your environment

WSL

What is the version of your Notation CLI or Notation Library?

notation CLI v1.0.0-rc.4

@yizha1 yizha1 added bug Something isn't working triage Need to triage labels Apr 25, 2023
@patrickzheng200 patrickzheng200 self-assigned this Apr 25, 2023
@patrickzheng200 patrickzheng200 added this to the 1.0.0 milestone Apr 25, 2023
@patrickzheng200
Copy link
Contributor

Will take this one.

@patrickzheng200 patrickzheng200 removed the bug Something isn't working label Apr 26, 2023
@yizha1 yizha1 added enhancement New feature or request and removed triage Need to triage labels Apr 26, 2023
priteshbandi pushed a commit that referenced this issue Apr 27, 2023
When NOTATION_EXPERIMENTAL variable is not set, experimental examples will be hidden. Resolves #645.

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
enhancement New feature or request
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants