canvas-component-push

Validate environment and execute Canvas pushes with retry handling for dependency failures.

3|1|Updated Feb 11, 2026
One-click install
npx skills add https://github.com/drupal-canvas/skills --skill canvas-component-push-drupal-canvas
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: canvas-component-push
Source: https://github.com/drupal-canvas/skills/tree/main/skills/canvas-component-push
Command: npx skills add https://github.com/drupal-canvas/skills --skill canvas-component-push-drupal-canvas

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Streamlines pushing validated Canvas components to Drupal Canvas and recovers from common push failures; it ensures setup is verified and provides structured guidance for retrying failed pushes.

Core Features & Use Cases

  • Setup gate: validates environment (.env) and required variables (CANVAS_SITE_URL, CANVAS_CLIENT_ID, CANVAS_CLIENT_SECRET) before pushing.
  • Push guidance: prompts to push with canvas push --yes and handles cases where unrelated Canvas changes exist.
  • Failure handling: differentiates between connection/setup failures (stop and verify setup) and dependency-related failures (retry until dependencies exist).

Quick Start

Confirm that Drupal Canvas CLI is installed and the environment is configured, then execute a safe push using canvas push --yes.

Frequently Asked Questions about canvas-component-push

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I push Canvas components safely when multiple components have dependencies?

To push Canvas components safely, use the canvas push --yes command. The workflow handles dependency-related failures by automatically retrying until required dependencies exist in the environment.

Why does my Canvas component push fail when unrelated Canvas changes exist?

Canvas pushes can fail due to unrelated changes. The workflow provides structured guidance to handle these scenarios, differentiating between connection failures and dependency issues for clear resolution.

What environment variables are required for a Drupal Canvas component push workflow?

A Canvas push workflow requires validating the .env file for three specific variables: CANVAS_SITE_URL, CANVAS_CLIENT_ID, and CANVAS_CLIENT_SECRET. The setup gate verifies these before executing push tasks.

Can I retry a failed Drupal Canvas CLI push automatically?

Yes, you can retry a failed Drupal Canvas CLI push. The workflow differentiates failures: it stops for connection or setup issues to verify configuration, and automatically retries dependency-related failures.

What is the best way to handle Canvas setup validation before pushing components?

The best way to handle Canvas setup validation is using an automated setup gate. It enforces environment checks and verifies required variables before attempting to push components, preventing common failures.