AI Agent Skill HUB

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.

25 stars
byComeOnOliver
View on GitHubInstallation ↓

Best use case

github-release-assistant is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

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.

Teams using github-release-assistant should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

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

Manual Installation

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

How github-release-assistant Compares

Feature / Agentgithub-release-assistantStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

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.

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.

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

creating-github-issues-from-web-research

25
from ComeOnOliver/skillshub

This skill enhances Claude's ability to conduct web research and translate findings into actionable GitHub issues. It automates the process of extracting key information from web search results and formatting it into a well-structured issue, ready for team action. Use this skill when you need to research a topic and create a corresponding GitHub issue for tracking, collaboration, and task management. Trigger this skill by requesting Claude to "research [topic] and create a ticket" or "find [information] and generate a GitHub issue".

release-notes-generator

25
from ComeOnOliver/skillshub

Release Notes Generator - Auto-activating skill for DevOps Basics. Triggers on: release notes generator, release notes generator Part of the DevOps Basics skill category.

navigating-github

25
from ComeOnOliver/skillshub

First-time GitHub setup and interactive git learning. Walks users from zero to a working GitHub repo, then teaches git through 9 hands-on lessons on their actual project. Adapts language and depth to skill level — inferred from environment, not questionnaires. Two modes: Setup (guided onboarding) and Learn (progressive curriculum from commits to CI/CD). Use when the user asks to set up GitHub, learn git, or says "teach me github". Trigger with "set up my repo", "help me with github", "teach me github", "learn git", "what are branches", "teach me PRs", or "how do I use github".

github-project-setup

25
from ComeOnOliver/skillshub

Github Project Setup - Auto-activating skill for Enterprise Workflows. Triggers on: github project setup, github project setup Part of the Enterprise Workflows skill category.

github-actions-starter

25
from ComeOnOliver/skillshub

Github Actions Starter - Auto-activating skill for DevOps Basics. Triggers on: github actions starter, github actions starter Part of the DevOps Basics skill category.

backlog-grooming-assistant

25
from ComeOnOliver/skillshub

Backlog Grooming Assistant - Auto-activating skill for Enterprise Workflows. Triggers on: backlog grooming assistant, backlog grooming assistant Part of the Enterprise Workflows skill category.

resume-assistant

25
from ComeOnOliver/skillshub

智能简历助手,通过五个AI代理提供全流程求职支持:(1)故事挖掘-发现经历亮点;(2)职位推荐-匹配合适岗位;(3)简历优化-针对JD定制内容;(4)模拟面试-实战演练与反馈;(5)能力提升-差距分析与计划。适用于简历创建、优化、面试准备、职业规划等求职相关任务。

persona-exec-assistant

25
from ComeOnOliver/skillshub

Manage an executive's schedule, inbox, and communications.

suggest-awesome-github-copilot-skills

25
from ComeOnOliver/skillshub

Suggest relevant GitHub Copilot skills from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing skills in this repository, and identifying outdated skills that need updates.

suggest-awesome-github-copilot-instructions

25
from ComeOnOliver/skillshub

Suggest relevant GitHub Copilot instruction files from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing instructions in this repository, and identifying outdated instructions that need updates.

suggest-awesome-github-copilot-agents

25
from ComeOnOliver/skillshub

Suggest relevant GitHub Copilot Custom Agents files from the awesome-copilot repository based on current repository context and chat history, avoiding duplicates with existing custom agents in this repository, and identifying outdated agents that need updates.

github-copilot-starter

25
from ComeOnOliver/skillshub

Set up complete GitHub Copilot configuration for a new project based on technology stack