Deploy to Contentstack Launch with GitHub Actions using Launch API

Author: SakshiKoli-CS

.env.example

@@ -0,0 +1,12 @@
+# Copy this file to .env and fill in your values:
+#   cp .env.example .env
+
+# Required: M2M app credentials (Developer Hub → Your App → Authentication → M2M)
+CONTENTSTACK_CLIENT_ID="your_client_id"
+CONTENTSTACK_CLIENT_SECRET="your_client_secret"
+
+# Region: AWS_NA, AWS_EU, AWS_AU, AZURE_NA, AZURE_EU, GCP_NA, GCP_EU
+CONTENTSTACK_REGION="AWS_NA"
+
+# Required: Launch project and environment
+ENVIRONMENT_UID="your_environment_uid"

.github/workflows/deploy.yml

@@ -0,0 +1,31 @@
+name: Deploy to Contentstack Launch
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+      
+      - name: Install deployment script dependencies
+        run: npm install form-data archiver dotenv
+      
+      - name: Deploy to Contentstack Launch
+        env:
+          CONTENTSTACK_CLIENT_ID: ${{ secrets.CONTENTSTACK_CLIENT_ID }}
+          CONTENTSTACK_CLIENT_SECRET: ${{ secrets.CONTENTSTACK_CLIENT_SECRET }}
+          CONTENTSTACK_REGION: ${{ secrets.CONTENTSTACK_REGION }}
+          PROJECT_UID: ${{ secrets.PROJECT_UID }}
+          ENVIRONMENT_UID: ${{ secrets.ENVIRONMENT_UID }}
+        run: node deploy-api.js

.gitignore

@@ -0,0 +1,5 @@
+node_modules
+.env
+.env*.local
+.next/
+.DS_Store

README.md

@@ -0,0 +1,54 @@
+# Deploy to Contentstack Launch with GitHub Actions using Launch API
+
+This repository shows how to deploy a Next.js app to **Contentstack Launch** using the [Launch Public API](https://www.contentstack.com/docs/developers/apis/launch-api) file upload with **GitHub Actions**. The workflow (`.github/workflows/deploy.yml`) runs on push to `main` and uses the deployment script `deploy-api.js`.
+
+---
+
+## What you need
+
+The Launch API supports [**M2M**, **OAuth**, or **Authtoken**](https://www.contentstack.com/docs/developers/apis/launch-api#authentication). This repo uses **M2M** (Client ID + Client Secret).
+
+| Variable | Description |
+|----------|-------------|
+| `CONTENTSTACK_CLIENT_ID` | M2M/OAuth app ID |
+| `CONTENTSTACK_CLIENT_SECRET` | M2M/OAuth app secret |
+| `CONTENTSTACK_REGION` | Region: <small>`AWS_NA`, `AWS_EU`, `AWS_AU`, `AZURE_NA`, `AZURE_EU`, `GCP_NA`, `GCP_EU`</small> |
+| `PROJECT_UID` | Launch project UID |
+| `ENVIRONMENT_UID` | Launch environment UID |
+
+---
+
+## Quick start
+
+1. Clone or copy this repo.
+2. Create an app with `launch:manage` or `launch.projects:write` scope (this repo uses M2M; OAuth/Authtoken are also supported by the API).
+3. Set the required variables as **GitHub Actions secrets**, or use `.env` for local runs.
+4. Push to `main` (or run `npm run deploy` locally).
+
+**Run locally:** Copy `.env.example` to `.env`, fill in values, then run `npm run deploy`.
+
+---
+
+## GitHub Actions
+
+Workflow: `.github/workflows/deploy.yml` — on push to `main`: checkout → `npm install` → `node deploy-api.js`.
+
+**Secrets** (Settings → Secrets and variables → Actions): `CONTENTSTACK_CLIENT_ID`, `CONTENTSTACK_CLIENT_SECRET`, `CONTENTSTACK_REGION`, `PROJECT_UID`, `ENVIRONMENT_UID`.
+
+---
+
+## What gets included in the deployment zip
+
+The deploy script (`deploy-api.js`) zips only the files and folders listed in the **`essentialFiles`** array inside `createZipFile()`. There is no config file — the list is hardcoded.
+
+**Default list:** `package.json`, `package-lock.json`, `next.config.js`, `pages`, `public`, `app`, `functions`
+
+**To customize:** Edit `deploy-api.js` and change the `essentialFiles` array in `createZipFile()` so it matches your project (e.g. add `src`, `components`, or `lib`; remove `app` or `functions` if you don’t use them). Only entries in that array are included in the zip.
+
+---
+
+## References
+
+- [Launch API – Authentication](https://www.contentstack.com/docs/developers/apis/launch-api#authentication)
+- [Contentstack OAuth](https://www.contentstack.com/docs/developers/developer-hub/contentstack-oauth)
+- [Contentstack Launch API](https://www.contentstack.com/docs/developers/apis/launch-api)