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.

Sign up for GitHub

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(spec): add subcommands to Notation plugin spec #555

Merged
merged 9 commits into from
Mar 29, 2023
Merged

doc(spec): add subcommands to Notation plugin spec #555

Changes from 2 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d03266e
Add plugin subcommands to spec
duffney Feb 15, 2023
fbb37b2
Merge branch 'notaryproject:main' into gh-549/notation-plugin-spec
duffney Feb 15, 2023
81e5cc7
Update specs/commandline/plugin.md
duffney Feb 16, 2023
057806d
Update specs/commandline/plugin.md
duffney Feb 16, 2023
613522e
Add uninstall and delete as aliases
duffney Feb 16, 2023
626442c
Apply suggestions from code review
duffney Mar 7, 2023
42f1819
Remove --name from plugin install subcommand
duffney Mar 22, 2023
ab4b118
Add: --force flag and revisted install description
duffney Mar 23, 2023
378e92c
changed moved to copied
duffney Mar 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 43 additions & 3 deletions specs/commandline/plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,55 @@ Aliases:
list, ls
```

### notation plugin install

```text
Installs a plugin
duffney marked this conversation as resolved.
Show resolved Hide resolved

Usage:
notation plugin install --name <plugin name> --plugin-package <plugin package> [flags]
duffney marked this conversation as resolved.
Show resolved Hide resolved

Flags:
-n, --name string name of the plugin
duffney marked this conversation as resolved.
Show resolved Hide resolved
duffney marked this conversation as resolved.
Show resolved Hide resolved
-p, --plugin-package string path to the plugin package
-h, --help help for install

Aliases:
install, add
```

### notation plugin remove

```text
Removes a plugin

Usage:
notation plugin remove <plugin name> [flags]
duffney marked this conversation as resolved.
Show resolved Hide resolved

Flags:
-h, --help help for remove

Aliases:
remove, rm
duffney marked this conversation as resolved.
Show resolved Hide resolved
```

## Usage

### Install a plugin

Currently there is no subcommand available for plugin installation. Plugin publisher should provide instructions to download and install the plugin.
```shell
notation plugin install --name <plugin name> --plugin-package <plugin package>
duffney marked this conversation as resolved.
Show resolved Hide resolved
duffney marked this conversation as resolved.
Show resolved Hide resolved
```

Unpon successful execution, the plugins directory is created under the default plugin directory if it does not exist, and the plugin package is extracted to the plugins directory. The plugin installation is then verified. If the verification fails, the plugin is removed from the plugins directory and an error is returned.
duffney marked this conversation as resolved.
Show resolved Hide resolved

### Uninstall a plugin

Currently there is no subcommand available for plugin un-installation. Plugin publisher should provide instructions to uninstall the plugin.
```shell
notation plugin remove <plugin name>
```

Upon successful execution, the plugin is removed from the plugins directory. If the plugin is not found, an error is returned showing the syntax for the plugin list command to show the installed plugins.

### List installed plugins

Expand All @@ -58,5 +98,5 @@ An example of output from `notation plugin list`:

```text
NAME DESCRIPTION VERSION CAPABILITIES ERROR
azure-kv Sign artifacts with keys in Azure Key Vault v0.3.1-alpha.1 [SIGNATURE_GENERATOR.RAW] <nil>
azure-kv Sign artifacts with keys in Azure Key Vault v0.5.0-rc.1 [SIGNATURE_GENERATOR.RAW] <nil>
```