#github-action #generate #basic

bin+lib github-actions-autodocs

为指定的 GitHub Action 生成基本的 README 文件

5 个版本

0.1.4 2023年4月7日
0.1.3 2023年4月6日
0.1.2 2023年4月5日
0.1.1 2023年4月5日
0.1.0 2023年4月5日

1197开发工具

每月下载 26

MIT 许可证

9KB
181

Github Actions Autodocs (GCA)

为指定的 GitHub Action 生成基本的 README 文件

安装

通过 cargo 安装

  cargo install github-actions-autodocs

用法

Usage: github-actions-autodocs [OPTIONS]

Options:
  -f, --file <FILE>      Source path [default: action.yml]
      --dry              Dry run
  -o, --output <OUTPUT>  Output filepath
  -h, --help             Print help
  -V, --version          Print version

Github Action

name: Generate Readme

on:
  push:

jobs:
  generate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: rawnly/github-actions-autodocs@main
        with:
          action-file: action.yml
      - shell: bash
        run: |
          git add -A .
          git commit -m 'docs: README'
          git push -u origin ${{ github.ref }}

提示:别名 github-actions-autodocsgca 😉

许可证

MIT 许可证

依赖

~5–14MB
~174K SLoC