deploy-preview

Deploy local builds to the ESO-Toolkit GitHub Pages preview site.

2|Updated Aug 18, 2025
One-click install
npx skills add https://github.com/ESO-Toolkit/eso-toolkit --skill deploy-preview
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: deploy-preview
Source: https://github.com/ESO-Toolkit/eso-toolkit/tree/main/.github/skills/deploy-preview
Command: npx skills add https://github.com/ESO-Toolkit/eso-toolkit --skill deploy-preview

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the process of deploying local code branches to a shared preview environment, enabling quick feedback and testing before merging.

Core Features & Use Cases

  • Deploy Local Builds: Push any local branch to the ESO-Toolkit/dev-previews GitHub Pages site.
  • Custom Aliases: Assign a unique URL alias to each preview for easy access and organization.
  • Preview Cleanup: Remove old or unwanted previews to keep the environment tidy.
  • Use Case: A developer working on a new feature can deploy their branch to a unique URL like https://eso-toolkit.github.io/dev-previews/my-new-feature/ to get immediate feedback from QA or stakeholders.

Quick Start

Deploy the current local branch to the dev-previews site using its branch name as the alias.

Frequently Asked Questions about deploy-preview

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

FAQPage Schema
How do I deploy a local build to a GitHub Pages preview environment?

To deploy a local build to a GitHub Pages preview environment, this Skill pushes your local branch to a shared dev-previews repository using an optional custom alias for unique URL access.

Can I assign a custom URL alias when pushing local builds for testing?

Yes, you can assign a custom URL alias when pushing local builds for testing, generating predictable preview links like the branch name for organized stakeholder feedback.

What do I need to set up before deploying local builds to dev-previews?

Before deploying local builds to dev-previews, you need Node.js with npm dependencies installed and a cloned sibling repository for the dev-previews GitHub Pages site.

How do I remove an existing preview from the shared testing environment?

To remove an existing preview from the shared testing environment, this Skill facilitates preview cleanup by targeting and deleting the specified alias from the dev-previews site.

What is the best way to share local code branches for QA feedback before merging?

The best way to share local code branches for QA feedback before merging is deploying them to a shared preview environment, which generates immediate accessible URLs for stakeholder review.

Does this preview deployment workflow require a specific repository structure?

Yes, this preview deployment workflow requires a specific repository structure, specifically needing a cloned sibling repository for the dev-previews site to push local builds successfully.