Merge pull request #479 from Kaggle/publish-kaggle-environments-core-to-npm

Publish @kaggle-environments/core to npm based on the version in the pythion TOML

Author: develra

cicd/cloudbuild.yaml

@@ -1,8 +1,7 @@
 steps:
-  # Step 1: Install dependencies and build all static assets.
+  # Step 1: Install dependencies, sync versions, and build all static assets.
   # This runs our 'build-ci' script which builds all visualizers and
   # collects the artifacts into a single './build' directory.
-  # If this gets much more complicated, we should make a bash or docker file.
   - name: "gcr.io/cloud-builders/npm"
     id: "build-all-visualizers"
     entrypoint: "bash"
@@ -13,9 +12,19 @@ steps:
         apt-get update && apt-get install -y jq
         npm install -g pnpm
         pnpm install
+        node web/scripts/sync-version.js
         pnpm build-ci
 
-  # Step 2: Deploy the collected artifacts to Google Cloud Storage.
+  # Step 2: Publish the core package to NPM.
+  # This runs after the build to ensure the package is up-to-date.
+  - name: "gcr.io/cloud-builders/npm"
+    id: "publish-to-npm"
+    entrypoint: "bash"
+    args: ["web/scripts/publish-core.sh"]
+    waitFor: ["build-all-visualizers"]
+    secretEnv: ["NPM_TOKEN"]
+
+  # Step 3: Deploy the collected artifacts to Google Cloud Storage.
   # 'rsync -d' syncs the directory and deletes any files in the destination
   # that are not in the source, We probably want to change this to keep versions
   # once we figure out a decent versioning scheme.
@@ -29,9 +38,14 @@ steps:
       - "-r"
       - "./build"
       - "gs://$_BUCKET_NAME/episode-visualizers"
-    waitFor: ["build-all-visualizers"]
+    waitFor: ["publish-to-npm"]
 
 substitutions:
   _BUCKET_NAME: "kaggle-static"
 
-tags: ["kaggle-environments", "visualizer-deployment"]
+availableSecrets:
+  secretManager:
+    - versionName: projects/kaggle-cicd/secrets/npm-token-kaggle-environments/versions/latest
+      env: "NPM_TOKEN"
+
+tags: ["kaggle-environments", "visualizer-deployment", "npm-publish"]

web/core/package.json

@@ -1,7 +1,9 @@
 {
   "name": "@kaggle-environments/core",
-  "private": true,
   "version": "0.0.0",
+  "publishConfig": {
+    "access": "public"
+  },
   "type": "module",
   "exports": {
     ".": {

web/scripts/publish-core.sh

@@ -0,0 +1,69 @@
+#!/bin/bash
+set -e
+
+echo "Installing dependencies..."
+npm install -g pnpm
+pnpm install
+
+echo "Building core library..."
+pnpm --filter @kaggle-environments/core build
+
+PACKAGE_NAME="@kaggle-environments/core"
+CORE_PACKAGE_JSON_PATH="web/core/package.json"
+VERSION_FROM_PACKAGE_JSON=$(grep -E '"version":\s*".*"' "$CORE_PACKAGE_JSON_PATH" | sed -E 's/.*"version":\s*"(.*)".*/\1/')
+
+if [ -z "$VERSION_FROM_PACKAGE_JSON" ]; then
+  echo "❌ Could not find version in $CORE_PACKAGE_JSON_PATH. Exiting."
+  exit 1
+fi
+
+echo "Found version $VERSION_FROM_PACKAGE_JSON. Proceeding to publish/verify loop."
+
+
+MAX_RETRIES=3
+RETRY_DELAY_SECONDS=20
+SUCCESS=false
+
+echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > web/core/.npmrc
+
+set +e
+
+for i in $(seq 1 $MAX_RETRIES)
+do
+  echo "--- Attempt $i/$MAX_RETRIES ---"
+
+  # 1. Check if the version now exists on the registry.
+  echo "Checking NPM registry for $PACKAGE_NAME@$VERSION_FROM_PACKAGE_JSON..."
+  if npm view "$PACKAGE_NAME@$VERSION_FROM_PACKAGE_JSON" version > /dev/null; then
+    echo "✅ Version found on NPM - Skipping Publish"
+    SUCCESS=true
+    break
+  fi
+
+  # 2. If not found, attempt to publish.
+  echo "Version not found. Attempting to publish..."
+  if pnpm --filter @kaggle-environments/core publish --no-git-checks; then
+    echo "Publish command succeeded. Will verify on the next attempt after a delay."
+  else
+    echo "Publish command failed."
+  fi
+
+  # 3. If this wasn't the last attempt, wait before retrying.
+  if [ "$i" -lt "$MAX_RETRIES" ]; then
+    echo "Waiting ${RETRY_DELAY_SECONDS}s before next attempt..."
+    sleep $RETRY_DELAY_SECONDS
+  fi
+done
+
+# Cleanup the .npmrc file regardless of outcome
+rm web/core/.npmrc
+
+# Re-enable failing on error
+set -e
+
+if [ "$SUCCESS" != "true" ]; then
+  echo "❌ Failed to publish or verify package after $MAX_RETRIES attempts. Aborting."
+  exit 1
+fi
+
+echo "🚀 Process complete."

web/scripts/sync-version.js

@@ -0,0 +1,32 @@
+const fs = require('fs');
+const path = require('path');
+
+const pyprojectPath = path.resolve(__dirname, '../../pyproject.toml');
+const packageJsonPath = path.resolve(__dirname, '../core/package.json');
+
+try {
+  // Read pyproject.toml
+  const pyprojectContent = fs.readFileSync(pyprojectPath, 'utf8');
+  const versionMatch = pyprojectContent.match(/^version\s*=\s*"(.+?)"/m);
+
+  if (!versionMatch) {
+    throw new Error('Could not find version in pyproject.toml');
+  }
+  const version = versionMatch[1];
+  console.log(`Found version ${version} in pyproject.toml`);
+
+  // Read package.json
+  const packageJsonContent = fs.readFileSync(packageJsonPath, 'utf8');
+  const packageJson = JSON.parse(packageJsonContent);
+
+  // Update version
+  packageJson.version = version;
+
+  // Write back to package.json
+  fs.writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + '\n');
+  console.log(`Successfully updated version in web/core/package.json to ${version}`);
+
+} catch (error) {
+  console.error('Error syncing version:', error.message);
+  process.exit(1);
+}