release-note-safety

Generate safe GitHub CLI commands for Markdown release notes with backticks.

2|Updated Jul 29, 2025

Search Tags:#github #release notes #gh cli #command injection #markdown safety #shell quoting

Ready to run

npx skills add https://github.com/kurojs/EnderDots --skill release-note-safety

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: release-note-safety
Source: https://github.com/kurojs/EnderDots/tree/main/.config/opencode/skills/release-note-safety
Command: npx skills add https://github.com/kurojs/EnderDots --skill release-note-safety

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents shell command-substitution bugs and malformed Markdown when creating or editing GitHub release notes that contain backticks, fenced code blocks, or multi-line content.

Core Features & Use Cases

Safe handling of backticks in shell strings: Avoids unintended command execution when release notes include inline code marked with backticks.
Reliable multi-line Markdown formatting: Uses quoted heredocs to preserve formatting and disable interpolation for complex notes.
Practical workflow for verification: Encourages checking the rendered release body after publishing or editing.

Quick Start

Use the release-note-safety skill to generate a safe command for editing release notes with backticks and multi-line sections in GitHub.

Frequently Asked Questions about release-note-safety

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

FAQPage Schema

How do I prevent shell injection when using backticks in GitHub release notes?▼

Preventing shell injection in GitHub release notes requires safe quoting rules to avoid unintended command execution from backticks. Using quoted heredocs for multi-line bodies disables interpolation, keeping inline code formatting intact.

Why does my Markdown formatting break when running gh release create with multi-line text?▼

Markdown formatting breaks during gh release create because standard shell quoting mangles multi-line text and fenced code blocks. Using a quoted heredoc preserves the exact formatting and prevents shell interpolation from altering the content.

What is the best way to verify release notes after publishing them with the GitHub CLI?▼

The best way to verify published release notes is running gh release view to retrieve the returned body. This post-edit verification step checks that the rendered Markdown matches your intended output after using gh release edit.

Can I use --notes-file instead of heredocs for complex GitHub release notes?▼

Yes, you can use --notes-file as an alternative to quoted heredocs for complex GitHub release notes. This approach bypasses shell quoting issues entirely by reading the Markdown content directly from a file during gh release create.

Does gh release edit support fenced code blocks without causing command substitution errors?▼

Yes, gh release edit supports fenced code blocks safely when you apply proper shell quoting rules. Using quoted heredocs ensures that backticks and code fences are treated as literal text rather than triggering command substitution.