Github release assistant
Skill ComeOnOliver/skillshub/skills/aiskillstore/marketplace/zhanlincui/github-release-assistant
đź§ The right skill, one API call. AI agent skills registry with token-efficient skill resolution. 5,000+ skills from 500+ top repos.
npx -y skills add ComeOnOliver/skillshub --skill github-release-assistantAssembled from the repository path, not quoted from the project. Check it against their README if it does not work.
What its author says it does
Copied from the file, not written here
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.
SKILL.md
1.9 KB, as published. Nobody here has run it
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
- Collect repo facts from
config.json,README.md,PROJECT_STRUCTURE.md,requirements*.txt, anddocs/. - Ask for missing details or have the user fill
release_assistant.json(seeassets/release_config.example.json). - Run the generator script to write README files.
- Review the diff with the user and refine content if needed.
- If requested, stage/commit/push changes with explicit confirmation.
Quick Start
- Create or edit
release_assistant.jsonin 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.mdandREADME.zh.md.
Git Workflow (Commit + Push)
- Run
git statusandgit diffto show changes. - Ask for confirmation before
git add,git commit, andgit 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.