Skip to content

docs: add projectId to clasp configuration examples #19

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.

Sign up for GitHub

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

Merged
h13 merged 2 commits into from
Mar 27, 2026
Merged

docs: add projectId to clasp configuration examples #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7d1a1c6
docs: add projectId to clasp configuration examples
h13 Mar 27, 2026
2e80592
fix: clarify projectId is a numeric string with examples
h13 Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/setup-github.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,21 @@ pnpm install
```json
{
"scriptId": "YOUR_SCRIPT_ID",
"projectId": "YOUR_GCP_PROJECT_ID",
"rootDir": "dist"
}
```

> **`projectId`** は Apps Script に紐づく GCP プロジェクト**番号**です（`"123456789"` のような数字列。`my-project-abc` のようなプロジェクト ID ではない）。Apps Script エディタ → プロジェクトの設定 → Google Cloud Platform（GCP）プロジェクトで確認できます。記載することで GCP プロジェクトの紐づけが宣言的・再現可能になります。省略時は clasp がスクリプトの既存 GCP プロジェクトを使用します。

### 3. GitHub Environments の設定

| Environment | Secret / Variable | 値 |
| ------------- | ------------------------- | ----------------------------------------- |
| `development` | Secret: `CLASP_JSON` | `{"scriptId":"DEV_ID","rootDir":"dist"}` |
| `development` | Variable: `DEPLOYMENT_ID` | dev のデプロイメント ID |
| `production` | Secret: `CLASP_JSON` | `{"scriptId":"PROD_ID","rootDir":"dist"}` |
| `production` | Variable: `DEPLOYMENT_ID` | prod のデプロイメント ID |
| Environment | Secret / Variable | 値 |
| ------------- | ------------------------- | ------------------------------------------------------------------ |
| `development` | Secret: `CLASP_JSON` | `{"scriptId":"DEV_ID","projectId":"GCP_NUM","rootDir":"dist"}` |
| `development` | Variable: `DEPLOYMENT_ID` | dev のデプロイメント ID |
| `production` | Secret: `CLASP_JSON` | `{"scriptId":"PROD_ID","projectId":"GCP_NUM","rootDir":"dist"}` |
| `production` | Variable: `DEPLOYMENT_ID` | prod のデプロイメント ID |

### 4. 確認とデプロイ

Expand Down
15 changes: 9 additions & 6 deletions docs/setup-github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,18 +33,21 @@ Create `.clasp-dev.json` and `.clasp-prod.json` (gitignored):
```json
{
"scriptId": "YOUR_SCRIPT_ID",
"projectId": "YOUR_GCP_PROJECT_ID",
"rootDir": "dist"
}
```

> **`projectId`** is the GCP project **number** associated with your Apps Script (a numeric string like `"123456789"`, not the alphanumeric project ID like `my-project-abc`). Find it in Apps Script editor → Project Settings → Google Cloud Platform (GCP) Project. Including it makes the GCP project association declarative and reproducible. If omitted, clasp uses the script's existing GCP project.

### 3. Configure GitHub environments

| Environment | Secret / Variable | Value |
| ------------- | ------------------------- | ----------------------------------------- |
| `development` | Secret: `CLASP_JSON` | `{"scriptId":"DEV_ID","rootDir":"dist"}` |
| `development` | Variable: `DEPLOYMENT_ID` | Your dev deployment ID |
| `production` | Secret: `CLASP_JSON` | `{"scriptId":"PROD_ID","rootDir":"dist"}` |
| `production` | Variable: `DEPLOYMENT_ID` | Your prod deployment ID |
| Environment | Secret / Variable | Value |
| ------------- | ------------------------- | ------------------------------------------------------------------ |
| `development` | Secret: `CLASP_JSON` | `{"scriptId":"DEV_ID","projectId":"GCP_NUM","rootDir":"dist"}` |
| `development` | Variable: `DEPLOYMENT_ID` | Your dev deployment ID |
| `production` | Secret: `CLASP_JSON` | `{"scriptId":"PROD_ID","projectId":"GCP_NUM","rootDir":"dist"}` |
| `production` | Variable: `DEPLOYMENT_ID` | Your prod deployment ID |

### 4. Verify and deploy

Expand Down
15 changes: 9 additions & 6 deletions docs/setup-gitlab.ja.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,23 @@ pnpm install
```json
{
"scriptId": "YOUR_SCRIPT_ID",
"projectId": "YOUR_GCP_PROJECT_ID",
"rootDir": "dist"
}
```

> **`projectId`** は Apps Script に紐づく GCP プロジェクト**番号**です（`"123456789"` のような数字列。`my-project-abc` のようなプロジェクト ID ではない）。Apps Script エディタ → プロジェクトの設定 → Google Cloud Platform（GCP）プロジェクトで確認できます。記載することで GCP プロジェクトの紐づけが宣言的・再現可能になります。省略時は clasp がスクリプトの既存 GCP プロジェクトを使用します。

### 3. CI/CD Variables の設定

Settings → CI/CD → Variables で以下を追加：

| 変数 | Environment scope | 値 | オプション |
| --------------- | ----------------- | ----------------------------------------- | ---------- |
| `CLASP_JSON` | `development` | `{"scriptId":"DEV_ID","rootDir":"dist"}` | Masked |
| `CLASP_JSON` | `production` | `{"scriptId":"PROD_ID","rootDir":"dist"}` | Masked |
| `DEPLOYMENT_ID` | `development` | dev のデプロイメント ID | |
| `DEPLOYMENT_ID` | `production` | prod のデプロイメント ID | |
| 変数 | Environment scope | 値 | オプション |
| --------------- | ----------------- | ------------------------------------------------------------------ | ---------- |
| `CLASP_JSON` | `development` | `{"scriptId":"DEV_ID","projectId":"GCP_NUM","rootDir":"dist"}` | Masked |
| `CLASP_JSON` | `production` | `{"scriptId":"PROD_ID","projectId":"GCP_NUM","rootDir":"dist"}` | Masked |
| `DEPLOYMENT_ID` | `development` | dev のデプロイメント ID | |
| `DEPLOYMENT_ID` | `production` | prod のデプロイメント ID | |

### 4. Template Sync の設定

Expand Down
15 changes: 9 additions & 6 deletions docs/setup-gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,20 +83,23 @@ Create `.clasp-dev.json` and `.clasp-prod.json` (gitignored):
```json
{
"scriptId": "YOUR_SCRIPT_ID",
"projectId": "YOUR_GCP_PROJECT_ID",
"rootDir": "dist"
}
```

> **`projectId`** is the GCP project **number** associated with your Apps Script (a numeric string like `"123456789"`, not the alphanumeric project ID like `my-project-abc`). Find it in Apps Script editor → Project Settings → Google Cloud Platform (GCP) Project. Including it makes the GCP project association declarative and reproducible. If omitted, clasp uses the script's existing GCP project.

### 3. Configure CI/CD Variables

Go to Settings → CI/CD → Variables and add:

| Variable | Environment scope | Value | Options |
| --------------- | ----------------- | ----------------------------------------- | ------- |
| `CLASP_JSON` | `development` | `{"scriptId":"DEV_ID","rootDir":"dist"}` | Masked |
| `CLASP_JSON` | `production` | `{"scriptId":"PROD_ID","rootDir":"dist"}` | Masked |
| `DEPLOYMENT_ID` | `development` | Your dev deployment ID | |
| `DEPLOYMENT_ID` | `production` | Your prod deployment ID | |
| Variable | Environment scope | Value | Options |
| --------------- | ----------------- | ------------------------------------------------------------------ | ------- |
| `CLASP_JSON` | `development` | `{"scriptId":"DEV_ID","projectId":"GCP_NUM","rootDir":"dist"}` | Masked |
| `CLASP_JSON` | `production` | `{"scriptId":"PROD_ID","projectId":"GCP_NUM","rootDir":"dist"}` | Masked |
| `DEPLOYMENT_ID` | `development` | Your dev deployment ID | |
| `DEPLOYMENT_ID` | `production` | Your prod deployment ID | |

### 4. Set up Template Sync

Expand Down
Loading