-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
write up on some ways to publish extensions #1660
Conversation
We recommend reading [GitHub's Releases Documentation](https://docs.github.com/en/free-pro-team@latest/github/administering-a-repository/managing-releases-in-a-repository) for how to actually do the steps of a release. | ||
The following will be a quick walk through on how to make the tarball which will be the released file. | ||
|
||
### Making a Tarball of your extension |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think npm pack
is the easiest way to create a valid tarball?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah cool, didn't know about that one. I was stumbling around trying to use tar
and find
and then I found this. I tried it on the lens repo and npm pack
adds a bunch of not-needed files (ones that are .gitignore
-ed). Should I add that as another option or keep this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Plain tarball is not a valid npm package so I think we should only document npm pack
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant this as a way for creating the tarball for github releases but sure I can document npm pack
instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Plain tarball does not work, Lens accepts only npm packages .
Signed-off-by: Sebastian Malton <sebastian@malton.name>
npm view <extension-name> dist.tarball | ||
``` | ||
|
||
This will output the link that they will need to give to lens to install your extension. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lens -> Lens
Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
@Nokel81 @panuhorsmalahti I tweaked the text to underline a fact that Lens needs a NPM tarball. |
@jakolehm looks good to me. Though you will have to approve since it is a PR in my name. |
@nevalla PTAL |
* write up on some ways to publish extensions Signed-off-by: Sebastian Malton <sebastian@malton.name> * tweak text Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> Co-authored-by: Jari Kolehmainen <jari.kolehmainen@gmail.com>
* write up on some ways to publish extensions Signed-off-by: Sebastian Malton <sebastian@malton.name> * tweak text Signed-off-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> Co-authored-by: Jari Kolehmainen <jari.kolehmainen@gmail.com> Co-authored-by: Sebastian Malton <sebastian@malton.name>
Signed-off-by: Sebastian Malton sebastian@malton.name
resolves #1611