Skip to content

update README

update README #114

Workflow file for this run

name: update README.md code blocks
on:
push:
branches:
- main
jobs:
update-readme:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v2
- name: "setup go"
uses: actions/setup-go@v3
with:
go-version: '1.23'
- name: "build binary and print --help"
run: |
go build -o ntgrrc .
./ntgrrc --help-all >help.txt
- name: Markdown autodocs
uses: dineshsonachalam/[email protected]
with:
# Optional, defaults to author of the commit that triggered the run
commit_author: Author <[email protected]>
# Optional, defaults to "[email protected]"
commit_user_email: [email protected]
# Optional, but recommended
# Defaults to "Apply automatic changes"
commit_message: Apply automatic changes
# Optional branch name where commit should be pushed to.
# Defaults to the current branch.
# branch: feature-123
# Optional output file paths, defaults to '[./README.md]'.
output_file_paths: '[./README.md]'
# Categories to automatically sync or transform its contents in the markdown files.
# Defaults to '[code-block,json-to-html-table,workflow-artifact-table]'
categories: '[code-block]'