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

write up on some ways to publish extensions #1660

Merged
merged 2 commits into from
Dec 7, 2020
Merged

write up on some ways to publish extensions #1660

merged 2 commits into from
Dec 7, 2020

Conversation

Nokel81
Copy link
Collaborator

@Nokel81 Nokel81 commented Dec 4, 2020

Signed-off-by: Sebastian Malton sebastian@malton.name

resolves #1611

@Nokel81 Nokel81 added area/extension Something to related to the extension api area/documentation labels Dec 4, 2020
@Nokel81 Nokel81 requested a review from a team December 4, 2020 16:11
@Nokel81 Nokel81 self-assigned this Dec 4, 2020
docs/extensions/testing-and-publishing/publishing.md Outdated Show resolved Hide resolved
docs/extensions/testing-and-publishing/publishing.md Outdated Show resolved Hide resolved
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
Copy link
Contributor

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?

Copy link
Collaborator Author

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?

Copy link
Contributor

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.

Copy link
Collaborator Author

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.

Copy link
Contributor

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.
Copy link
Contributor

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>
@jakolehm
Copy link
Contributor

jakolehm commented Dec 7, 2020

@Nokel81 @panuhorsmalahti I tweaked the text to underline a fact that Lens needs a NPM tarball.

@Nokel81
Copy link
Collaborator Author

Nokel81 commented Dec 7, 2020

@jakolehm looks good to me. Though you will have to approve since it is a PR in my name.

@jakolehm
Copy link
Contributor

jakolehm commented Dec 7, 2020

@nevalla PTAL

@jakolehm jakolehm merged commit 22a8442 into master Dec 7, 2020
@jakolehm jakolehm deleted the issue-1611 branch December 7, 2020 12:43
jakolehm added a commit that referenced this pull request Dec 7, 2020
* 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>
jakolehm added a commit that referenced this pull request Dec 7, 2020
* 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>
@jakolehm jakolehm mentioned this pull request Dec 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation area/extension Something to related to the extension api
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Publishing Extensions
4 participants