[plugins] New github repo structure

.github/workflows/cli-tests.yaml

@@ -113,7 +113,7 @@ jobs:
           DEVBOX_DEBUG: ${{ (!matrix.run-example-tests || inputs.example-debug) && '1' || '0' }}
           DEVBOX_EXAMPLE_TESTS: ${{ matrix.run-example-tests }}
           # Used in `go test -timeout` flag. Needs a value that time.ParseDuration can parse.
-          DEVBOX_GOLANG_TEST_TIMEOUT: "${{ (github.ref == 'refs/heads/main' || inputs.run-mac-tests) && '35m' || '15m' }}"
+          DEVBOX_GOLANG_TEST_TIMEOUT: "${{ (github.ref == 'refs/heads/main' || inputs.run-mac-tests) && '35m' || '20m' }}"
         run: |
           go test -v -timeout $DEVBOX_GOLANG_TEST_TIMEOUT ./...
 

examples/plugins/github-with-revision/devbox.json

@@ -11,6 +11,6 @@
     }
   },
   "include": [
-    "github:jetpack-io/devbox-plugin-example/6ea0ef9e12ab58dbbb145ca8f3a465611cb603a9#devbox"
+    "github:jetpack-io/devbox-plugin-example/d9c00334353c9b1294c7bd5dbea128c149b2eb3a"
   ]
 }

examples/plugins/github/devbox.json

@@ -12,6 +12,6 @@
   },
   "include": [
     "github:jetpack-io/devbox-plugin-example",
-    "github:jetpack-io/devbox-plugin-example#custom-name"
+    "github:jetpack-io/devbox-plugin-example?dir=custom-dir"
   ]
 }

internal/plugin/github.go

@@ -7,7 +7,6 @@ import (
 	"strings"
 
 	"github.com/pkg/errors"
-	"github.com/samber/lo"
 	"go.jetpack.io/devbox/internal/boxcli/usererr"
 	"go.jetpack.io/devbox/internal/cuecfg"
 )
@@ -17,31 +16,33 @@ type githubPlugin struct {
 	org      string
 	repo     string
 	revision string
-	fragment string
+	dir      string
 }
 
 // newGithubPlugin returns a plugin that is hosted on github.
-// url is of the form org/repo#name
-// The repo must have a [name].json in the root of the repo. If fragment is
-// not set, it defaults to "default"
-func newGithubPlugin(url string) (*githubPlugin, error) {
-	path, fragment, _ := strings.Cut(url, "#")
+// url is of the form org/repo?dir=<dir>
+// The (optional) dir must have a plugin.json"
+func newGithubPlugin(rawURL string) (*githubPlugin, error) {
+	pluginURL, err := url.Parse(rawURL)
+	if err != nil {
+		return nil, err
+	}
 
-	parts := strings.Split(path, "/")
+	parts := strings.Split(pluginURL.Path, "/")
 
 	if len(parts) < 2 || len(parts) > 3 {
 		return nil, usererr.New(
 			"invalid github plugin url %q. Must be of the form org/repo/[revision]",
-			url,
+			rawURL,
 		)
 	}
 
 	plugin := &githubPlugin{
-		raw:      url,
+		raw:      rawURL,
 		org:      parts[0],
 		repo:     parts[1],
 		revision: "master",
-		fragment: fragment,
+		dir:      pluginURL.Query().Get("dir"),
 	}
 
 	if len(parts) == 3 {
@@ -68,6 +69,7 @@ func (p *githubPlugin) FileContent(subpath string) ([]byte, error) {
 		p.org,
 		p.repo,
 		p.revision,
+		p.dir,
 		subpath,
 	)
 	if err != nil {
@@ -82,7 +84,7 @@ func (p *githubPlugin) FileContent(subpath string) ([]byte, error) {
 	if res.StatusCode != http.StatusOK {
 		return nil, usererr.New(
 			"failed to get plugin github:%s (Status code %d). \nPlease make sure a "+
-				"[name].json or default.json file exists in the root of the repo.",
+				"plugin.json file exists in plugin directory.",
 			p.raw,
 			res.StatusCode,
 		)
@@ -91,8 +93,7 @@ func (p *githubPlugin) FileContent(subpath string) ([]byte, error) {
 }
 
 func (p *githubPlugin) buildConfig(projectDir string) (*config, error) {
-	configName, _ := lo.Coalesce(p.fragment, "default")
-	content, err := p.FileContent(configName + ".json")
+	content, err := p.FileContent("plugin.json")
 	if err != nil {
 		return nil, errors.WithStack(err)
 	}