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

fix: update docs and RFD4 to reflect manifest field usage #629

Merged
merged 1 commit into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 10 additions & 4 deletions site/content/docs/guide/config/policy-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,16 @@ to the plugin's download manifest. For an example of the manifest field, see
registry is established, the manifest field will become optional. In the
immediate term it will be practically required.

At runtime, each plugin will be downloaded by Hipcheck, its size and checksum
verified, and the plugin contents decompressed and unarchived to produce the
plugin executable artifacts which will be stored in a local plugin cache.
Hipcheck will do the same recursively for all plugins.
The `manifest` field can be either a URL to the plugin's **download manifest**,
or a local path to the plugin's **plugin manifest**. The latter option exists
to allow for local testing of plugins without requiring the changes first be
published.

At runtime, each plugin that does not have a local-path-type `manifest` field
will be downloaded by Hipcheck, its size and checksum verified, and the plugin
contents decompressed and unarchived to produce the plugin executable artifacts
which will be stored in a local plugin cache. Hipcheck will do the same
recursively for all plugins.

In the future Hipcheck will likely add some form of dependency resolution to
minimize duplication of shared dependencies, similar to what exists in other
Expand Down
23 changes: 14 additions & 9 deletions site/content/docs/rfds/0004-plugin-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -511,17 +511,22 @@ As you can see, the file has two main sections: a `plugins` section, and an

This section defines the plugins that will be used to run the analyses
described in the file. These plugins are defined in the same way dependent
plugins are defined in the plugin manifest, with a plugin name, version,
and an optional `manifest` field (not shown in the example above) which
provides a link to the plugin's download manifest. In the future, when a
Hipcheck plugin registry is established, the `manifest` field will become
plugins are defined in the plugin manifest, with a plugin name, version, and an
optional `manifest` field (not shown in the example above). In the future, when
a Hipcheck plugin registry is established, the `manifest` field will become
optional. In the immediate term it will be practically required.

Each plugin will be downloaded by Hipcheck, its size and checksum
verified, and the plugin contents decompressed and unarchived to produce
the plugin executable artifacts and plugin manifest which will be stored
in a local plugin cache. Hipcheck will do the same recursively for all
plugins.
The `manifest` field can be either a URL link to the plugin's **download**
manifest file, or a local path to a plugin's **plugin** manifest file. The
latter case is to allow for local testing of plugins without requiring the
changes be published.

Each plugin without a local-path-type `manifest` field will be downloaded by
Hipcheck, its size and checksum verified, and the plugin contents decompressed
and unarchived to produce the plugin executable artifacts and plugin manifest
which will be stored in a local plugin cache. Hipcheck will do the same
recursively for all plugins. Local-path-type `manifest` plugins will have their
plugin manifest and endpoint binary copied to the plugin cache.

In the future Hipcheck will likely add some form of dependency resolution
to minimize duplication of shared dependencies, similar to what exists in
Expand Down