https://github.com/rawnly/github-actions-autodocs
https://github.com/rawnly/github-actions-autodocs
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rawnly/github-actions-autodocs
- Owner: rawnly
- Created: 2023-04-05T16:39:52.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-07T00:23:40.000Z (about 3 years ago)
- Last Synced: 2024-12-28T09:43:23.224Z (over 1 year ago)
- Language: Rust
- Size: 23.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Github Actions Autodocs (GCA)
Generate a basic readme for the given github action
## Installation
Install via cargo
```sh
cargo install github-actions-autodocs
```
## Usage
```sh
Usage: github-actions-autodocs [OPTIONS]
Options:
-f, --file Source path [default: action.yml]
--dry Dry run
-o, --output Output filepath
-h, --help Print help
-V, --version Print version
```
## Github Action
```yaml
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 }}
```
> TIP: Alias `github-actions-autodocs` to `gca` 😉
### LICENSE
The MIT License