docs(skill): tighten description and revise backup guidance#33
Merged
Conversation
Address suggestions from issue #1: - Description now leads with a capability statement ("Manages Upsun projects — ...") before the trigger phrases, following the "[what it does]. Use when [triggers]" pattern that skill registries match on. - Quick Start deploy step now states the exit-code contract explicitly: a non-zero `upsun push` means the deploy did not complete. Drops the prior bullet that could read as optional. - Adds a "Production deploys: backups before risky changes" subsection that points at `backup:list` first and only suggests `backup:create --live` if a recent backup doesn't cover the pre-deploy state. - Rewrites Backup / Restore to recommend `--live` as the default (no downtime, what automated backups use), reframe the non-live default as a freeze of unpredictable length, and call out that retention is finite so new backups can evict older ones. - Softens the "always create a safety backup before restore" safety rule, which conflicts with finite retention and is rarely useful since current state is usually not worth keeping when you're restoring. Refs: #1 Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Upsun skill documentation to improve registry matching, deploy verification guidance, and backup/restore safety recommendations.
Changes:
- Rewrites the skill description to lead with capabilities before trigger phrases.
- Adds deploy exit-code guidance and production backup guidance before risky changes.
- Revises backup/restore recommendations around live backups, downtime, and finite retention.
Comments suppressed due to low confidence (1)
plugins/upsun/skills/upsun/SKILL.md:156
- This production deploy check also assumes the application is named
app. Since application names vary by project, this can direct the agent to run a logs command that does not work for many Upsun projects; use the generic tail command or require resolving the application name first.
After deploying, `upsun logs app --tail -e <prod>` is the fastest signal that something has regressed.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Addresses suggestions from #1:
upsun pushmeans the deploy did not complete.backup:listfirst and only suggestsbackup:create --liveif a recent backup doesn't cover the pre-deploy state.--liveas the default (no downtime, what automated backups use), reframe the non-live default as a freeze of unpredictable length, and call out that retention is finite so new backups can evict older ones. Drops the misleading "~15-30s pause" number.Closes #1