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: create CLI spec for managing trust policies (phase 1) #568

Merged
merged 14 commits into from Mar 17, 2023

Conversation

yizha1
Copy link
Contributor

@yizha1 yizha1 commented Feb 25, 2023

Update:

  • Create CLI spec for managing trust policies for phase 1

Signed-off-by: Yi Zha yizha1@microsoft.com

Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1 yizha1 added documentation Improvements or additions to documentation spec Specifications to define the product requirements labels Feb 25, 2023
@yizha1 yizha1 linked an issue Feb 25, 2023 that may be closed by this pull request
@codecov-commenter
Copy link

codecov-commenter commented Feb 25, 2023

Codecov Report

Merging #568 (5d789ab) into main (e47cf12) will not change coverage.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##             main     #568   +/-   ##
=======================================
  Coverage   34.36%   34.36%           
=======================================
  Files          32       32           
  Lines        1848     1848           
=======================================
  Hits          635      635           
  Misses       1192     1192           
  Partials       21       21           

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

@yizha1 yizha1 changed the title doc: create CLI spec for managing trust policies doc: create CLI spec for managing trust policies (phase 1) Feb 27, 2023
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1
Copy link
Contributor Author

yizha1 commented Mar 4, 2023

@priteshbandi A new option was added for notation policy export to export a template file of trust policy for users to start from scratch.

@yizha1 yizha1 requested a review from priteshbandi March 4, 2023 03:09
Signed-off-by: Yi Zha <yizha1@microsoft.com>
@JeyJeyGao
Copy link
Contributor

How to update a trust policy? Does the import command needs to merge the new trust policy with the old one? Or just replace the old one?

@yizha1
Copy link
Contributor Author

yizha1 commented Mar 8, 2023

How to update a trust policy? Does the import command needs to merge the new trust policy with the old one? Or just replace the old one?

The import command will replace the old one. To update a trust policy, users can export the existing policies to a file, update the file and import it again. The second phase for managing trust policy is to introduce new commands for add/update/delete policies.

specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <yizha1@microsoft.com>
Signed-off-by: Yi Zha <yizha1@microsoft.com>
priteshbandi
priteshbandi previously approved these changes Mar 10, 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 a nitpick

specs/commandline/policy.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <yizha1@microsoft.com>
@yizha1
Copy link
Contributor Author

yizha1 commented Mar 13, 2023

@shizhMSFT @priteshbandi @priteshbandi your comments are resolved, and I also marked notation policy as a command in Preview status for RC-4.

specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <yizha1@microsoft.com>
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <yizha1@microsoft.com>
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 a nit

specs/commandline/policy.md Outdated Show resolved Hide resolved
priteshbandi
priteshbandi previously approved these changes Mar 15, 2023
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
specs/commandline/policy.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <yizha1@microsoft.com>
Copy link
Contributor

@patrickzheng200 patrickzheng200 left a comment

Choose a reason for hiding this comment

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

LGTM

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

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

@yizha1 yizha1 merged commit 124c6c8 into notaryproject:main Mar 17, 2023
@yizha1 yizha1 deleted the tp_cli_phase1 branch March 17, 2023 03:50
duffney pushed a commit to duffney/notation that referenced this pull request Mar 30, 2023
…ject#568)

Update:
- Create CLI spec for managing trust policies for phase 1

Signed-off-by: Yi Zha <yizha1@microsoft.com>
Signed-off-by: Josh Duffney <jduffney@microsoft.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation spec Specifications to define the product requirements
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

CLI Cmds for trust policy management - phase 1
7 participants