diff --git a/.github/workflows/release-prepare.yml b/.github/workflows/release-prepare.yml index ac87be8..0a94ecb 100644 --- a/.github/workflows/release-prepare.yml +++ b/.github/workflows/release-prepare.yml @@ -38,6 +38,11 @@ jobs: echo "prev_version=$(cat .version)" >> $GITHUB_OUTPUT bin/version.sh ${{ github.event.inputs.release_type }} echo "next_version=$(cat .version)" >> $GITHUB_OUTPUT + - name: Update Documentation + id: update-docs + run: | + echo "Update documentation for version ${{ steps.version.outputs.next_version }}" + bin/docs.sh - name: Create pull request id: create-pull-request # https://github.com/peter-evans/create-pull-request diff --git a/README.md b/README.md index 9a7b0af..a2a3564 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # lib-bash – Bash Libraries -![Lib-Bash Decorative Image](img/LibBashGitHubSocialPreview.jpg) +![Lib-Bash Decorative Image](docs/img/LibBashGitHubSocialPreview.jpg) A set of libraries to use from within your Bash scripts. @@ -51,6 +51,20 @@ ${COLOR_YELLOW}This is yellow text.${COLOR_RESET} EOF ``` +### lib_gnucompat + +Utility functions and dynamically defined constants for scripts preferring +(or requiring) GNU compatible tooling. Meant especially for systems such as +MacOS, to prefer GNU-Tools like `coreutils` by preferring prefixed tools like +`gsed`, `gawk`. + +**Usage Examples**: + +```bash +echo "Hello, World!" | \ + "${SED}" --regexp-extended "s/World/GNU/g" +``` + ### lib_init Apply general recommended strictness settings for Bash scripts. Includes support diff --git a/bin/doc-single.sh b/bin/doc-single.sh new file mode 100755 index 0000000..49c759f --- /dev/null +++ b/bin/doc-single.sh @@ -0,0 +1,51 @@ +#!/usr/bin/env bash +### +### Script to generate Markdown documentation for a single script. +### +### In contrast to more sophisticated approaches, this script just generates +### the Markdown from lines starting with three hashes (###) and the following +### line. +### +### Usage: +### +### ```bash +### doc-single.sh