Promoting Definitions Across Environments

Promote the definitions in your project repository from development to testing and production with unmeshed update-remote. Configure integration settings, secrets, and variables directly in each target environment; they usually differ between environments.

For the development workflow, see Developing Definitions with the Unmeshed CLI.

In a pipeline, provide the target server URL as UNMESHED_ENGINE_URL and the API key as UNMESHED_API_KEY from the environment's secret store. Pass the key to login through stdin, then update the namespace:

Login verifies the API key and makes that server active for the following CLI command. With --non-interactive, missing login inputs cause the job to fail instead of waiting for a prompt. Use the testing server and its credential for testing, then the production server and its credential for production.

By default, update-remote replaces the supported resources in the target namespace:

1. It validates the local definitions and saves a backup of the current remote namespace before changing it.
2. It deletes the current remote resources, then uploads all definitions from the local namespace folder.
3. If deletion or upload fails, it removes the partial update and attempts to restore the previous definitions from the backup. The command reports a failure, and a failed restoration may need manual recovery.

Definitions that are absent from the local folder are removed from the remote namespace in this default mode. Keep the local folder complete for the namespace you are promoting.

The Setup Unmeshed CLI action on GitHub Marketplace installs the CLI and makes unmeshed available to later steps. For example, configure a GitHub testing environment with a UNMESHED_ENGINE_URL variable and a UNMESHED_API_KEY secret, then use:

Use a separate GitHub environment with the production URL and credential when promoting to production.