Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

improve formatting, move reason for shellcheck disable on same line #140

Merged
merged 1 commit into from
Aug 18, 2023
Merged

improve formatting, move reason for shellcheck disable on same line #140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 28 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ We recommend you use the following code at the beginning of your script in case

<setup>

<!-- auto-generated, do not modify here but in src/setup.sh -->
<!-- auto-generated, do not modify here but in src/setup.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -139,7 +139,7 @@ Following an example:

<ci-install-shellcheck>

<!-- auto-generated, do not modify here but in src/ci/install-shellcheck.sh -->
<!-- auto-generated, do not modify here but in src/ci/install-shellcheck.sh.doc -->
```bash
# run the install-shellcheck.sh in your github/gitlab workflow
# for instance, assuming you fetched this file via gt and remote name is tegonal-scripts
Expand All @@ -160,7 +160,7 @@ jobs:

<ci-install-shellspec>

<!-- auto-generated, do not modify here but in src/ci/install-shellspec.sh -->
<!-- auto-generated, do not modify here but in src/ci/install-shellspec.sh.doc -->
```bash
# run the install-shellcheck.sh in your github/gitlab workflow
# for instance, assuming you fetched this file via gt and remote name is tegonal-scripts
Expand All @@ -186,7 +186,7 @@ Helper function which performs a signin and redeploycontainers

<ci-jelastic-deploy>

<!-- auto-generated, do not modify here but in src/ci/jelastic/deploy.sh -->
<!-- auto-generated, do not modify here but in src/ci/jelastic/deploy.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -254,7 +254,7 @@ The most important functions are defined in this file: jelastic_signin which in

<ci-jelastic-utils>

<!-- auto-generated, do not modify here but in src/ci/jelastic/utils.sh -->
<!-- auto-generated, do not modify here but in src/ci/jelastic/utils.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -293,7 +293,7 @@ settings for shellcheck.

<qa-run-shellcheck>

<!-- auto-generated, do not modify here but in src/qa/run-shellcheck.sh -->
<!-- auto-generated, do not modify here but in src/qa/run-shellcheck.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -371,7 +371,7 @@ Full usage example:

<releasing-update-version-README>

<!-- auto-generated, do not modify here but in src/releasing/update-version-README.sh -->
<!-- auto-generated, do not modify here but in src/releasing/update-version-README.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -430,7 +430,7 @@ Full usage example:

<releasing-update-version-scripts>

<!-- auto-generated, do not modify here but in src/releasing/update-version-scripts.sh -->
<!-- auto-generated, do not modify here but in src/releasing/update-version-scripts.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -489,7 +489,7 @@ Full usage example:

<releasing-update-version-issue-templates>

<!-- auto-generated, do not modify here but in src/releasing/update-version-issue-templates.sh -->
<!-- auto-generated, do not modify here but in src/releasing/update-version-issue-templates.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -562,7 +562,7 @@ Full usage example:

<releasing-toggle-sections>

<!-- auto-generated, do not modify here but in src/releasing/toggle-sections.sh -->
<!-- auto-generated, do not modify here but in src/releasing/toggle-sections.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -617,7 +617,7 @@ Full usage example:

<releasing-sneak-peek-banner>

<!-- auto-generated, do not modify here but in src/releasing/sneak-peek-banner.sh -->
<!-- auto-generated, do not modify here but in src/releasing/sneak-peek-banner.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -701,7 +701,7 @@ Full usage example:

<releasing-release-files>

<!-- auto-generated, do not modify here but in src/releasing/release-files.sh -->
<!-- auto-generated, do not modify here but in src/releasing/release-files.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -750,7 +750,7 @@ Utility functions when dealing with arrays.

<utility-array-utils>

<!-- auto-generated, do not modify here but in src/utility/array-utils.sh -->
<!-- auto-generated, do not modify here but in src/utility/array-utils.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -798,7 +798,7 @@ Utility functions to interact with the user.

<utility-ask>

<!-- auto-generated, do not modify here but in src/utility/ask.sh -->
<!-- auto-generated, do not modify here but in src/utility/ask.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand All @@ -822,7 +822,7 @@ Utility functions which check some conditions like is passed arg the correct typ

<utility-checks>

<!-- auto-generated, do not modify here but in src/utility/checks.sh -->
<!-- auto-generated, do not modify here but in src/utility/checks.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -882,7 +882,7 @@ Utility functions around git.

<utility-git-utils>

<!-- auto-generated, do not modify here but in src/utility/git-utils.sh -->
<!-- auto-generated, do not modify here but in src/utility/git-utils.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -941,7 +941,7 @@ Utility functions which hopefully make it easier for you to deal with gpg

<utility-gpg-utils>

<!-- auto-generated, do not modify here but in src/utility/gpg-utils.sh -->
<!-- auto-generated, do not modify here but in src/utility/gpg-utils.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -971,7 +971,7 @@ trustGpgKey ~/.gpg info.com

<utility-http>

<!-- auto-generated, do not modify here but in src/utility/http.sh -->
<!-- auto-generated, do not modify here but in src/utility/http.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand All @@ -992,7 +992,7 @@ wgetAndVerify "https://github.com/tegonal/gt/.gt/signing-key.public.asc"

<utility-io>

<!-- auto-generated, do not modify here but in src/utility/io.sh -->
<!-- auto-generated, do not modify here but in src/utility/io.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -1029,7 +1029,7 @@ Utility functions to log messages including a severity level where logError writ

<utility-log>

<!-- auto-generated, do not modify here but in src/utility/log.sh -->
<!-- auto-generated, do not modify here but in src/utility/log.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -1114,7 +1114,7 @@ Full usage example:

<utility-parse-args>

<!-- auto-generated, do not modify here but in src/utility/parse-args.sh -->
<!-- auto-generated, do not modify here but in src/utility/parse-args.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -1166,7 +1166,7 @@ Full usage example:

<utility-parse-fn-args>

<!-- auto-generated, do not modify here but in src/utility/parse-fn-args.sh -->
<!-- auto-generated, do not modify here but in src/utility/parse-fn-args.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -1212,7 +1212,7 @@ Full usage example:

<utility-parse-commands>

<!-- auto-generated, do not modify here but in src/utility/parse-commands.sh -->
<!-- auto-generated, do not modify here but in src/utility/parse-commands.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -1254,7 +1254,7 @@ Utility functions when parsing (see also [Parse arguments](#parse-arguments)).

<utility-parse-utils>

<!-- auto-generated, do not modify here but in src/utility/parse-utils.sh -->
<!-- auto-generated, do not modify here but in src/utility/parse-utils.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -1287,7 +1287,7 @@ Utility function to find out the initial `declare` statement after following `de

<utility-recursive-declare-p>

<!-- auto-generated, do not modify here but in src/utility/recursive-declare-p.sh -->
<!-- auto-generated, do not modify here but in src/utility/recursive-declare-p.sh.doc -->
```bash
#!/usr/bin/env bash
# shellcheck disable=SC2034
Expand Down Expand Up @@ -1329,7 +1329,7 @@ Full usage example:

<utility-replace-snippet>

<!-- auto-generated, do not modify here but in src/utility/replace-snippet.sh -->
<!-- auto-generated, do not modify here but in src/utility/replace-snippet.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -1373,7 +1373,7 @@ Establishes a guard by creating a variable based on the file which shall be sour

<utility-source-once>

<!-- auto-generated, do not modify here but in src/utility/source-once.sh -->
<!-- auto-generated, do not modify here but in src/utility/source-once.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -1416,7 +1416,7 @@ Full usage example:

<utility-update-bash-docu>

<!-- auto-generated, do not modify here but in src/utility/update-bash-docu.sh -->
<!-- auto-generated, do not modify here but in src/utility/update-bash-docu.sh.doc -->
```bash
#!/usr/bin/env bash
set -euo pipefail
Expand Down
2 changes: 1 addition & 1 deletion src/utility/update-bash-docu.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,5 @@ function updateBashDocumentation() {
-pe "s/(###+\s+Usage\s+###+\n#\n)[\S\s]+?(\n#\n###+)/\$1${quotedSnippet}\$2/g;" \
"$script" || die "could not replace the Usage section for %s" "$script"

replaceSnippet "$script" "$id" "$dir" "$pattern" "$markdownSnippet"
replaceSnippet "$script.doc" "$id" "$dir" "$pattern" "$markdownSnippet"
}