chore(docs): document how to package and publicly release plugins #848
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
j-lanson
requested review from
alilleybrinker,
cstepanian,
mchernicoff,
devin-b-lake and
ninaagrawal
alilleybrinker
requested changes
Jan 29, 2025
j-lanson
force-pushed
the
jlanson/distribute-docs
branch
from
1b3f6bf to
445806e
Compare
alilleybrinker
approved these changes
Jan 29, 2025
Signed-off-by: jlanson <[email protected]>
alilleybrinker
force-pushed
the
jlanson/distribute-docs
branch
from
445806e to
fbb4d17
Compare
ninaagrawal
reviewed
Jan 29, 2025
|
|
||
| To start the packaging process, create a directory that contains your plugin | ||
| artifacts. Inside that directory you must write a [plugin manifest file](#the-plugin-manifest-file) | ||
| named `plugin.kdl` that tells Hipcheck how to run it. After you have written |
There was a problem hiding this comment.
"it" could be more specific. I'm assuming it refers to the plugin artifacts
| By now you should have a directory somewhere on your machine containing your | ||
| plugin manifest file and all of the artifacts for your plugin. Assuming your | ||
| plugin manifest has an entry in `entrypoint` that matches your current | ||
| architecture, you can run the plugin in a Hipcheck analysis. If built your |
There was a problem hiding this comment.
If built should be changed to if you built
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #849 .