# actions-vercel

## ガイド

- [ガイド](/ja/guide/what-is-actions-vercel.md): nexterias/actions-vercel で GitHub Actions から Vercel をビルド・デプロイし、連携機能を活用する方法を紹介します。
- [はじめる](/ja/guide/getting-started.md): GitHub リポジトリ、Vercel プロジェクト、アクセストークン、シークレットを設定して、初回デプロイを始める手順です。
- [Monorepoを使用する](/ja/guide/monorepo.md): GitHub Actions と actions-vercel で Monorepo を使用するためのガイドです。
- [削除したブランチのDeploymentを削除する](/ja/guide/cleanup-deployments.md): 削除した GitHub ブランチに紐づく Vercel Deployment を、GitHub Actions で安全に自動削除する方法を説明します。

## リファレンス

- [token](/ja/references/inputs/required/token.md): Vercelのアクセストークンを指定する必須入力です。機密情報はGitHub Secretsに安全に保存してください。
- [project-id](/ja/references/inputs/required/project-id.md): VercelプロジェクトのIDを指定する必須入力です。対象プロジェクトに対応するIDを設定してください。
- [org-id](/ja/references/inputs/required/org-id.md): 指定したVercelプロジェクトが所属する組織のIDを指定する必須入力です。プロジェクトの組織IDを設定します。
- [build-env](/ja/references/inputs/optional/build-env.md): Vercel上でビルドを実行するときに設定する環境変数を指定するオプションです。prebuilt有効時はvercel build実行時に設定します。
- [cleanup-deployment](/ja/references/inputs/optional/cleanup-deployment.md): deleteイベントで削除したGitHubブランチに紐づくVercel Deploymentを削除するオプションです。デフォルトはfalseです。
- [cwd](/ja/references/inputs/optional/cwd.md): actions-vercelを実行するプロジェクトのルートディレクトリのパスを指定するオプションです。デフォルトはprocess.cwd()の値です。
- [domain-alias](/ja/references/inputs/optional/domain-alias.md): Vercelのドメインエイリアスを指定する非推奨のオプションです。v2で削除予定のため、ダッシュボードで設定します。
- [env](/ja/references/inputs/optional/env.md): 起動中のアプリケーションに渡す環境変数を指定するオプションです。Vercelのダッシュボードからも設定できます。
- [github-deployment-environment](/ja/references/inputs/optional/github-deployment-environment.md): GitHub Deployment Environmentを指定する非推奨のオプションです。v2で削除される予定です。
- [github-token](/ja/references/inputs/optional/github-token.md): GitHubのPersonal Access Tokenまたはsecrets.GITHUB_TOKENを指定し、デプロイメントやステータスの更新に使用します。
- [prebuilt](/ja/references/inputs/optional/prebuilt.md): GitHub Actions側でビルドを実行し、vercel buildとvercel deploy --prebuiltでVercelへデプロイするオプションです。
- [production](/ja/references/inputs/optional/production.md): 本番環境へのデプロイを有効にするオプションです。trueを指定すると本番へデプロイされ、デフォルトはfalseです。
- [public](/ja/references/inputs/optional/public.md): ソースコードを/_srcパスに公開するかを指定するオプションです。trueを指定すると公開され、デフォルトはfalseです。
- [deployment-url](/ja/references/outputs/deployment-url.md): デプロイされたアプリケーションのURLを文字列として取得する出力です。ワークフロー内の後続処理で利用できます。
- [deployment-status](/ja/references/outputs/deployment-status.md): vercel deployの完了時ステータスを文字列として取得する出力です。デプロイ結果に応じた状態を確認できます。