Skip to content

Add docs for running shfmt on shell scripts

Adam Cohen requested to merge add-shfmt-to-shell-scripting-guide into master

What does this MR do?

Now that this comment has been addressed and an official alpine-based Docker image is available, we can remove replace the note in the shell scripting guide docs with an example of how to automatically add a shfmt job to the CI/CD pipeline.

Related issues

No related issue

Testing

Tested in this pipeline

Author's checklist (required)

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by 🤖 GitLab Bot 🤖

Merge request reports

Loading