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

GitHub Enterprise (GHE) publishing support #172

Open
1 of 6 tasks
gerrit opened this issue Jul 30, 2018 · 3 comments
Open
1 of 6 tasks

GitHub Enterprise (GHE) publishing support #172

gerrit opened this issue Jul 30, 2018 · 3 comments

Comments

@gerrit
Copy link
Contributor

gerrit commented Jul 30, 2018

We run an internal GHE instance and would like to benefit from skpm's publishing workflow and baked-in auto-updating. Currently, skpm publish doesn't support GHE, in fact a lot of places in the code make the assumption. GHE supports the GitHub REST API, so afaict it should be possible to support internal plugin publication using skpm relatively easily.

We're happy to work on the implementation of this if you'd accept such a patch.

Current state

When running skpm publish minor --repo-url=https://<GHE-HOSTNAME>/user/repo.git the output is ✖ ERROR Error: Missing "repository" field in the package.json. which is pretty unhelpful. Same result if a non-github-dot-com repository field exists in package.json.

Proposed changes

Here's what a path to GHE support might look like:

  • be clearer in help & docs when skpm assumes a public GitHub repo / github.com URL and when it can be any instance. "GitHub repo" is ambiguous for GHE users and suggest an internal instance could work
  • improve error message for skpm publish when used /w non github.com URL
  • introduce a central concept of a "GitHub host" somewhere, use that to build the various GitHub API URLs across the codebase
  • support arbitrary repository URLs, assume it's a GHE instance when it doesn't
  • detect when a --repo-url is not on GitHub.com and automatically enable --skip-registry
  • fail gracefully if a repository URL happens to not point to any GitHub instance
@mathieudutour
Copy link
Member

Happy to accept patches, I do realise that publishing for non-GH repos sucks!

That being said, I'm working (at a Sketch employee) on introducing a plugin registry (a bit like npm) where we will store the different plugin versions so all of the publishing on GitHub hack that we have now will disappear.

@simareeno
Copy link

@mathieudutour is it possible to update plugins on GHE now without publishing appcast.xml and zips on public?

@mathieudutour
Copy link
Member

mathieudutour commented Oct 16, 2018

No, Sketch needs to be able to access them. Otherwise it would mean building a GHE authentication inside Sketch and I don’t think that’s something we will ever do

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants