Receber por email
← Voltar para o catálogo

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.

367estrelas
Atualizado há 4 meses

Ver no GitHub ↗

Como adicionar

/plugin marketplace add aiskillstore/marketplace

O comando exato pode variar conforme o repositório. Confira o README no GitHub.

Para o autor da skill

Cole no README do seu repo

Mostra que sua skill está catalogada na Skillteca, gera backlink e tráfego rastreável.

[![Skillteca](https://www.skillteca.com.br/api/badge/github-release-assistant/svg)](https://www.skillteca.com.br/skills/github-release-assistant)

Alerta por categoria

Receba novas skills de Escrita e Conteúdo toda segunda

1 email curto, só com as skills novas de Escrita e Conteúdo. 4 minutos de leitura, sem spam, cancela com 1 clique.

Você confirma o email no primeiro envio. Sem spam. Cancela com 1 clique.

Ler descrição completa

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.
Compartilhar X LinkedIn