github-release-assistant

Generate bilingual GitHub release documentation (README.md + README.zh.md) from repo metadata and user input, and guide release prep with git add/commit/push. Use when the user asks to write or polish README files, create bilingual docs, prepare a GitHub release, or mentions release assistant/README generation.

242 stars

byaiskillstore

View on GitHub Installation ↓

Best use case

github-release-assistant is best used when you need a repeatable AI agent workflow instead of a one-off prompt. It is especially useful for teams working in multi. Generate bilingual GitHub release documentation (README.md + README.zh.md) from repo metadata and user input, and guide release prep with git add/commit/push. Use when the user asks to write or polish README files, create bilingual docs, prepare a GitHub release, or mentions release assistant/README generation.

Users should expect a more consistent workflow output, faster repeated execution, and less time spent rewriting prompts from scratch.

Practical example

Example input

Use the "github-release-assistant" skill to help with this workflow task. Context: Generate bilingual GitHub release documentation (README.md + README.zh.md) from repo metadata and user input, and guide release prep with git add/commit/push. Use when the user asks to write or polish README files, create bilingual docs, prepare a GitHub release, or mentions release assistant/README generation.

Example output

A structured workflow result with clearer steps, more consistent formatting, and an output that is easier to reuse in the next run.

When to use this skill

Use this skill when you want a reusable workflow rather than writing the same prompt again and again.

When not to use this skill

Do not use this when you only need a one-off answer and do not need a reusable workflow.
Do not use it if you cannot install or maintain the related files, repository context, or supporting tools.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/github-release-assistant/SKILL.md --create-dirs "https://raw.githubusercontent.com/aiskillstore/marketplace/main/skills/zhanlincui/github-release-assistant/SKILL.md"

Manual Installation

Download SKILL.md from GitHub
Place it in .claude/skills/github-release-assistant/SKILL.md inside your project
Restart your AI agent — it will auto-discover the skill

How github-release-assistant Compares

Feature / Agent	github-release-assistant	Standard Approach
Platform Support	Not specified	Limited / Varies
Context Awareness	High	Baseline
Installation Complexity	Unknown	N/A

Frequently Asked Questions

What does this skill do?

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

Related Guides

Best AI Skills for ChatGPT

Find the best AI skills to adapt into ChatGPT workflows for research, writing, summarization, planning, and repeatable assistant tasks.

SKILL.md Source

# GitHub Release Assistant

## Overview
Generate polished README files in English and Chinese using repo facts plus a small config file, following a concise “Redmax-style” layout. Produce `README.md` + `README.zh.md`, then optionally guide a clean git commit and push.

## Workflow
1. Collect repo facts from `config.json`, `README.md`, `PROJECT_STRUCTURE.md`, `requirements*.txt`, and `docs/`.
2. Ask for missing details or have the user fill `release_assistant.json` (see `assets/release_config.example.json`).
3. Run the generator script to write README files.
4. Review the diff with the user and refine content if needed.
5. If requested, stage/commit/push changes with explicit confirmation.

## Quick Start
- Create or edit `release_assistant.json` in the repo root (optional but recommended).
- Run:
  `python3 /Users/cuizhanlin/.codex/skills/github-release-assistant/scripts/generate_release_readme.py --project-root <repo> --language both --overwrite`
- Verify `README.md` and `README.zh.md`.

## Git Workflow (Commit + Push)
- Run `git status` and `git diff` to show changes.
- Ask for confirmation before `git add`, `git commit`, and `git push`.
- Propose a concise commit message (e.g., `docs: add bilingual README`), and wait for approval.

## Resources
- Script: `scripts/generate_release_readme.py`.
- Templates: `assets/readme_template_en.md`, `assets/readme_template_zh.md`.
- Config example: `assets/release_config.example.json`.
- Style cues: `references/redmax_style.md`.
- Outline guide: `references/readme_outline.md`.

Related Skills

image-assistant

242

from aiskillstore/marketplace

配图助手 - 把文章/模块内容转成统一风格、少字高可读的 16:9 信息图提示词；先定“需要几张图+每张讲什么”，再压缩文案与隐喻，最后输出可直接复制的生图提示词并迭代。

github-repo-search

242

from aiskillstore/marketplace

帮助用户搜索和筛选 GitHub 开源项目，输出结构化推荐报告。当用户说"帮我找开源项目"、"搜一下GitHub上有什么"、"找找XX方向的仓库"、"开源项目推荐"、"github搜索"、"/github-search"时触发。

github-actions-docs

242

from aiskillstore/marketplace

Use when users ask how to write, explain, customize, migrate, secure, or troubleshoot GitHub Actions workflows, workflow syntax, triggers, matrices, runners, reusable workflows, artifacts, caching, secrets, OIDC, deployments, custom actions, or Actions Runner Controller, especially when they need official GitHub documentation, exact links, or docs-grounded YAML guidance.

llm-application-dev-ai-assistant

242

from aiskillstore/marketplace

You are an AI assistant development expert specializing in creating intelligent conversational interfaces, chatbots, and AI-powered applications. Design comprehensive AI assistant solutions with natur

github-issue-creator

242

from aiskillstore/marketplace

Convert raw notes, error logs, voice dictation, or screenshots into crisp GitHub-flavored markdown issue reports. Use when the user pastes bug info, error messages, or informal descriptions and wants a structured GitHub issue. Supports images/GIFs for visual evidence.

github-automation

242

from aiskillstore/marketplace

Automate GitHub repositories, issues, pull requests, branches, CI/CD, and permissions via Rube MCP (Composio). Manage code workflows, review PRs, search code, and handle deployments programmatically.

github-actions-templates

242

from aiskillstore/marketplace

Create production-ready GitHub Actions workflows for automated testing, building, and deploying applications. Use when setting up CI/CD with GitHub Actions, automating development workflows, or creating reusable workflow templates.

address-github-comments

242

from aiskillstore/marketplace

Use when you need to address review or issue comments on an open GitHub Pull Request using the gh CLI.

feature-design-assistant

242

from aiskillstore/marketplace

Turn ideas into fully formed designs and specs through natural collaborative dialogue. Use when planning new features, designing architecture, or making significant changes to the codebase.

openclaw-feishu-ops-assistant

242

from aiskillstore/marketplace

Feishu (Lark) workspace operations for OpenClaw agents. Provides document CRUD, cloud drive management, permission control, and knowledge-base navigation through a unified tool surface. Activate when user mentions Feishu docs, wiki, drive, permissions, or Lark cloud documents.

home-assistant-manager

242

from aiskillstore/marketplace

Expert-level Home Assistant configuration management with efficient deployment workflows (git and rapid scp iteration), remote CLI access via SSH and hass-cli, automation verification protocols, log analysis, reload vs restart optimization, and comprehensive Lovelace dashboard management for tablet-optimized UIs. Includes template patterns, card types, debugging strategies, and real-world examples.

release-skills

242

from aiskillstore/marketplace

Release workflow for baoyu-skills plugin. Use when user says "release", "发布", "push", "推送", "new version", "新版本", "bump version", "更新版本", or wants to publish changes to remote. Analyzes changes since last tag, updates CHANGELOG (EN/CN), bumps marketplace.json version, commits, and creates version tag. MUST be used before any git push with uncommitted skill changes.