Skills github-release-assistant

📦

github-release-assistant

Name: github-release-assistant
Author: ZhanlinCui

Safe

Generate bilingual GitHub release documentation

Creating polished release documentation takes time and requires consistency across languages. This skill automates bilingual README generation from your existing repo metadata.

Supports: Claude Codex Code(CC)

🥇 84 Gold

Download the skill ZIP

Upload in Claude

Go to Settings → Capabilities → Skills → Upload skill

Toggle on and start using

Test it

Using "github-release-assistant". Repository with config.json containing project metadata and a requirements.txt file

Expected outcome:

Two files created: README.md (English) and README.zh.md (Chinese) with matching structure including project overview, key capabilities, quickstart instructions, and license badges

Using "github-release-assistant". Run generator with --language both --overwrite flags on existing documentation

Expected outcome:

Updated README files replace previous versions while preserving git history through staged changes ready for review

Security Audit

Safe

v1 • 2/24/2026

Static analysis flagged 53 patterns but all are false positives. The 'weak cryptographic algorithm' warnings match MATLAB function names (BDF1, BDF2, ode45) in documentation, not actual crypto code. 'Ruby backtick execution' is Python code with markdown documentation formatting. Hardcoded URLs are standard badge images from shields.io. Unicode regex detects CJK characters for bilingual support. No malicious intent, no credential handling, no external API calls beyond static badge URLs.

Files scanned

676

Lines analyzed

findings

Total audits

No security issues found

Audited by: claude

Quality Score

Architecture

100

Maintainability

Content

Community

100

Security

Spec Compliance

What You Can Build

Open Source Project Maintainer

Generate consistent bilingual release documentation for each GitHub version release without manually writing both language versions.

International Developer

Quickly create Chinese and English README files for projects targeting both domestic and international audiences.

Research Code Distribution

Produce professional documentation for academic software releases with clear section structure and installation instructions.

Try These Prompts

Basic README Generation

Generate bilingual README files for my repository using the default template.

Custom Configuration

Create README.md and README.zh.md using the settings in release_assistant.json for project name, features, and quickstart steps.

Selective Language Output

Generate only the Chinese README (README.zh.md) using existing project metadata and overwrite if files exist.

Full Release Workflow

Generate both README files, show me the git diff, then guide me through committing and pushing the changes with an appropriate commit message.

Best Practices

Review generated README content before committing to ensure accuracy of extracted metadata
Create release_assistant.json with custom project details for consistent output across releases
Use git diff to preview changes before running git add and commit operations

Avoid

Do not commit generated README files without reviewing extracted content for accuracy
Avoid using --overwrite flag unless you intend to replace existing documentation completely
Do not run git push without first verifying the diff shows only intended documentation changes

Frequently Asked Questions

What files does this skill need to generate documentation?

The skill reads config.json, README.md, PROJECT_STRUCTURE.md, requirements.txt, and LICENSE from your repository. At minimum it needs a repo directory to extract the project name.

Can I customize the README template?

Yes, edit the template files in assets/readme_template_en.md and assets/readme_template_zh.md or provide custom templates via --template-dir flag.

Does this skill create actual GitHub releases?

No, it only generates README documentation files. Creating GitHub releases via API requires additional permissions and is outside this skill's scope.

How does the skill handle bilingual content?

It detects Chinese/Japanese/Korean characters using regex and extracts content from existing documentation, or uses provided config values for both English and Chinese sections.

What if my project uses a different configuration format?

Create a release_assistant.json file in your repo root following the example in assets/release_config.example.json to provide custom metadata.

Is my code sent to external servers during generation?

No, all processing happens locally. The only external URLs are static badge images from shields.io embedded in the generated README markdown.