introduce perses object in package.json and change the way the archiv…

…es are created (#7) Signed-off-by: Augustin Husson <husson.augustin@gmail.com>
perses · Aug 6, 2024 · e9b6a4a · e9b6a4a
1 parent 2fb1dc1
commit e9b6a4a
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 28 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -30,7 +30,6 @@ jobs:
           name: archives
           path: |
             **/*.tar.gz
-            **/mf-manifest.json
             !node_modules
 
   lint:
@@ -67,4 +66,4 @@ jobs:
         uses: actions/download-artifact@v4
         with:
           name: archives
-      - run: go run ./scripts/upload-archive/upload-archive.go -tag=${{ github.event.release.tag_name }}
+      - run: go run ./scripts/upload-archive/upload-archive.go -tag=${{ github.event.release.tag_name }}
diff --git a/BarChart/package.json b/BarChart/package.json
@@ -27,5 +27,8 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "perses": {
+    "pluginType":"panel"
+  }
 }
diff --git a/GaugeChart/package.json b/GaugeChart/package.json
@@ -27,5 +27,8 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "perses": {
+    "pluginType":"panel"
+  }
 }
diff --git a/MarkdownChart/package.json b/MarkdownChart/package.json
@@ -29,5 +29,8 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "perses": {
+    "pluginType":"panel"
+  }
 }
diff --git a/StatChart/package.json b/StatChart/package.json
@@ -27,5 +27,8 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "perses": {
+    "pluginType":"panel"
+  }
 }
diff --git a/TimeseriesChart/package.json b/TimeseriesChart/package.json
@@ -28,5 +28,8 @@
   },
   "files": [
     "dist"
-  ]
+  ],
+  "perses": {
+    "pluginType":"panel"
+  }
 }
diff --git a/scripts/build-archive/build-archive.go b/scripts/build-archive/build-archive.go
@@ -22,28 +22,30 @@ import (
 	"github.com/sirupsen/logrus"
 )
 
+var pluginFiles = []string{
+	"dist/",
+	"package.json",
+	"README.md",
+}
+
 func createArchive(pluginName string) error {
-	distPath := path.Join(pluginName, "dist")
 	manifest, err := npm.ReadManifest(pluginName)
 	if err != nil {
 		return err
 	}
-	newArchiveFolder := path.Join(pluginName, manifest.ID)
-	// Let's copy the dist folder just to ensure we have the correct folder name for the archive
-	if execErr := exec.Command("cp", "-r", distPath, newArchiveFolder).Run(); execErr != nil {
-		return fmt.Errorf("unable to copy the dist folder to the path %s: %w", newArchiveFolder, execErr)
+	newArchiveFolder := path.Join(pluginName, "tmp")
+	for _, f := range pluginFiles {
+		if execErr := exec.Command("cp", "-r", path.Join(pluginName, f), newArchiveFolder).Run(); execErr != nil {
+			return fmt.Errorf("unable to copy the folder/file to the path %s: %w", f, execErr)
+		}
 	}
+
 	// Then let's create the archive with the folder previously created
-	archiveName := fmt.Sprintf("%s.tar.gz", manifest.ID)
-	if execErr := exec.Command("tar", "-czvf", path.Join(pluginName, archiveName), newArchiveFolder).Run(); execErr != nil {
+	archiveName := fmt.Sprintf("%s-%s.tar.gz", manifest.ID, manifest.Metadata.BuildInfo.Version)
+	if execErr := exec.Command("tar", "-czvf", path.Join(pluginName, archiveName), newArchiveFolder, "--transform", fmt.Sprintf("s/%s\\/tmp/%s/", pluginName, pluginName)).Run(); execErr != nil {
 		return execErr
 	}
 
-	// Finally, move the archive to the dist folder,
-	// so it will be straightforward to find it back during the release process.
-	if execErr := exec.Command("mv", path.Join(pluginName, archiveName), distPath).Run(); execErr != nil {
-		return execErr
-	}
 	return exec.Command("rm", "-rf", newArchiveFolder).Run()
 }
 

diff --git a/scripts/npm/npm.go b/scripts/npm/npm.go
@@ -35,9 +35,19 @@ func GetWorkspaces() ([]string, error) {
 	return pkg.Workspaces, nil
 }
 
+type BuildInfo struct {
+	Version string `json:"buildVersion"`
+	Name    string `json:"buildName"`
+}
+
+type Metadata struct {
+	BuildInfo BuildInfo `json:"buildInfo"`
+}
+
 type Manifest struct {
-	ID   string `json:"id"`
-	Name string `json:"name"`
+	ID       string   `json:"id"`
+	Name     string   `json:"name"`
+	Metadata Metadata `json:"metaData"`
 }
 
 func ReadManifest(pluginPath string) (*Manifest, error) {

diff --git a/scripts/upload-archive/upload-archive.go b/scripts/upload-archive/upload-archive.go
@@ -20,7 +20,6 @@ import (
 	"path"
 	"regexp"
 
-	"github.com/perses/perses-plugins/scripts/npm"
 	"github.com/sirupsen/logrus"
 )
 
@@ -34,11 +33,7 @@ func main() {
 		logrus.Fatalf("Invalid tag name: %s", *tag)
 	}
 	pluginName := tagSplitted[1]
-	manifest, err := npm.ReadManifest(pluginName)
-	if err != nil {
-		logrus.Fatal(err)
-	}
-	if execErr := exec.Command("gh", "release", "upload", *tag, path.Join(pluginName, "dist", fmt.Sprintf("%s.tar.gz", manifest.ID))).Run(); execErr != nil {
-		logrus.WithError(err).Fatalf("unable to upload archive %s", pluginName)
+	if execErr := exec.Command("gh", "release", "upload", *tag, path.Join(pluginName, fmt.Sprintf("%s.tar.gz", *tag))).Run(); execErr != nil {
+		logrus.WithError(execErr).Fatalf("unable to upload archive %s", pluginName)
 	}
 }