launch-sync-environment-variables-from-env-example

作者: contentstack

Fetch environment variables from a Contentstack Launch project, compare them with a local `.env.example` file, and patch the target environment to add any…

npx skills add https://github.com/contentstack/contentstack-agent-skills --skill launch-sync-environment-variables-from-env-example

Sync Launch environment variables from .env.example

Description

Fetch environment variables from a Contentstack Launch project, compare them with a local .env.example file, and patch the target environment to add any missing keys.

When to Use

Use when a Launch environment must match the keys defined in a local .env.example file. Use to audit missing environment variables before a deployment. Use to add missing variable names to a Launch environment without manually editing config.

User Problem

A Launch environment can drift from the variables expected by a frontend project. This skill checks the environment against .env.example and updates Launch when keys are missing.

Success Criteria

All keys present in .env.example exist in the target Launch environment. Missing keys are added through the Launch Projects/Environments API. The script reports what was missing and what was updated. No secrets are printed in logs.

Expected Inputs

  • Launch project UID
  • Launch environment UID
  • Path to local .env.example file
  • Launch API credentials or authenticated context
  • Optional: dry-run flag

Expected Outputs

  • List of keys found in .env.example
  • List of keys already present in Launch
  • List of missing keys that were patched
  • Summary of API calls made
  • Exit code indicating success or failure

Example User Requests

  • Generate a Node.js script that syncs Launch environment variables from .env.example.
  • Compare my Launch environment variables with .env.example and add any missing keys.
  • Write a script to patch missing Launch environment variables for project abc123 and environment dev456.

Workflow Summary

Read and parse the local .env.example file. Fetch the target Launch environment and its current variables. Compare keys from the file against keys in Launch. Build a minimal patch payload containing only missing keys. Call PATCH /projects/{project_uid}/environments/{environment_uid}. Report the changes and stop without exposing values.

Instructions

Parse input

Read the local .env.example file and extract variable names. Ignore comments, blank lines, and malformed entries.

Fetch Launch state

Use the Launch API to get the target project and environment, then read the current environment variables.

Compare keys

Compare .env.example keys against Launch keys. Identify only missing keys unless the user explicitly asks to update existing values.

Patch environment

Call PATCH /projects/{project_uid}/environments/{environment_uid} with the minimal update needed to add missing keys.

Report results

Return a concise summary of missing keys, patched keys, and any errors. Never print secret values or tokens.

Output Format

Use concise, machine-readable summaries. Do not print secret values from Launch or local files. Show missing keys and updated keys separately. Include the project UID and environment UID in the summary. If running in dry-run mode, clearly label that no changes were made.

Tooling Notes

Use the Launch API and Projects/Environments endpoints. Validate project and environment UIDs before patching. Avoid logging deployment tokens or environment secrets. Use the smallest possible PATCH payload. If the API returns validation errors, surface them without retrying blindly.

Security

Defaults

Never expose deployment tokens or environment secrets. Validate project and environment targets before patching. Do not print variable values in logs or output. Require explicit user intent before making any change. Prefer dry-run behavior unless the user asks to apply changes.

Destructive Actions

Treat any PATCH that changes Launch configuration as a destructive external action. Confirm the target project and environment before applying changes. Do not broaden the update beyond missing keys unless the user explicitly requests it.

Secrets

Never reveal secret values from .env.example or Launch. Log only key names and counts. Redact tokens, API keys, and environment values in all output.

Environment Variables

Read environment variables only as needed for authentication and target selection. Never echo env var values. Support loading from local .env.example for comparison only, not for secret disclosure.

Product Context

    • Product: Launch
    • Description: Contentstack Launch: hosting, deployment, edge delivery, serverless functions, environment management, and CI/CD for Contentstack-powered frontends.
    • Product safety rules: - Never expose deployment tokens or environment secrets.
  • Validate deployment targets before triggering.
  • Require confirmation for production deployments.
  • Never auto-deploy to production without review.
    • Default tools: ["Launch API", "Projects", "Environments", "Deployments", "Serverless Functions", "Edge Delivery", "Custom Domains"]
    • Default connectors: ["Launch Proxy", "GitHub", "CI/CD Pipelines"]

来自 contentstack 的更多技能

brand-kit-assistant
contentstack
为用户提供关于Contentstack品牌工具包的概念、设置、治理及符合品牌规范的AI生成建议。将API相关任务引导至正确的品牌工具包功能或…
official
cms-assets
contentstack
为开发者提供关于在Contentstack中组织、交付和转换资源的建议。涵盖文件夹结构、图片交付API转换、发布……
official
cms-branches-aliases
contentstack
指导开发者使用Contentstack分支进行独立内容开发,以及使用别名实现零停机内容部署。涵盖分支策略、…
official
cms-data-modeling-best-practices
contentstack
指导开发者使用最简单可复用的结构在Contentstack中建模内容。该技能解释了何时使用内容类型、引用、全局…
official
cms-entries
contentstack
为开发者提供关于查询、本地化、版本管理、发布和结构化Contentstack条目的建议,以实现高效交付。重点介绍CDA的使用、引用…
official
cms-environments-publishing
contentstack
为开发者提供关于配置环境、发布内容、使用分发和预览令牌、利用同步API以及理解CDN和……的建议
official
cms-live-preview-visual-builder-support-assistant
contentstack
诊断并指导Contentstack Live Preview和Visual Builder的实现。追踪预览上下文,识别损坏的契约,并推荐…
official
cms-localization
contentstack
为开发者提供Contentstack本地化建议:语言设置、回退链、本地化与非本地化条目、不可本地化字段及多语言环境…
official