Github-Action: Generate Docs from Bash Scripts

Github Action to auto-generate Antora module with Asciicoc contents based on inline-docs from bash script. Inline-docs must comply to shdoc.

Github Badge Github Badge Github Badge


No inputs specified


A new Antora module in docs/modules/auto-generated-bash-docs folder with generated asciidoc contents. The action expects valid docs/antora.yml file.

Example usage

- name: Checkout code
  uses: actions/checkout@v3

- name: Generate docs from bash scripts
  uses: sebastian-sommerfeld-io/github-action-generate-docs@main

- name: Commit and push
  uses: EndBug/add-and-commit@v9
    author_name: your-name
    message: "your commit message"
    add: docs/modules

Bash script docs

Make sure your bash script docs align with

# @file libexample
# @brief A library that solves some common problems.
# @description
#     The project solves lots of problems:
#      * Some problem
#      * Some other problem


# @description My super function.
# Not thread-safe.
# @example
#    echo "test: $(say-hello World)"
# @arg $1 string A value to print
# @exitcode 0 If successful
# @exitcode 1 If an empty string passed
say-hello() {
  if [[ ! "$1" ]]; then
    return 1;

  echo "Hello $1"

Risks and Technical Debts

Scale for Probability and Impact: Low, Medium and High

# Title Description Probability Impact Response








Feel free to contact me via or visit my website