docker-mailserver/.github/workflows
Brennan Kinney fb72f3ad52
ci(docs): Fail when build aborts from broken links (#2266)
Using `set -ex` will exit the script as soon as a non-zero exit code is returned, such as when the docker image fails building the docs due to `build --strict` catching broken links. This also removes the need for `|| exit` when changing directory.

This seems fine for a small script, but AFAIK an alternative fix is just adding `|| exit` to the end of the `docker run` command too? There appears to be advice [against adopting `-e` carelessly](http://mywiki.wooledge.org/BashFAQ/105), while others [encourage `-e`](http://redsymbol.net/articles/unofficial-bash-strict-mode/). I know that several maintainers here have preference towards `set -e` so I've kept the original PR solution.

Additionally:

- `-x` is used to improve command visibility when reviewing the workflow log output.
- `--name` isn't necessary, but was part of the original PR.
- I've chosen not to include `-o pipefail`, only because no pipes are used in this script.

* docs(fix): Fix broken links

* ci(docs): Added inline docs

Extra documentation context for maintainers to quickly grok what's going on.

* chore(docs): Minor typo fix by wernerfred

Added from their related PR by request.
2021-10-31 09:13:18 +13:00
..
scripts/docs ci(docs): Fail when build aborts from broken links (#2266) 2021-10-31 09:13:18 +13:00
close_stale_issues.yml chore(deps): bump actions/stale from 3 to 4 (#2089) 2021-07-20 09:01:51 +02:00
contributors.yml Run contributors workflow monthly 2021-09-30 06:49:53 +00:00
default_on_push.yml chore(deps): bump docker/metadata-action from 3.5.0 to 3.6.0 (#2258) 2021-10-26 12:08:19 +02:00
docs-preview-deploy.yml chore(deps): bump myrotvorets/set-commit-status-action (#2167) 2021-09-05 09:22:49 +00:00
docs-preview-prepare.yml docs(deps): bump mkdocs-material to 7.1.6 (#2015) 2021-05-31 19:02:56 +12:00
docs-production-deploy.yml docs(ci): Deploy Previews (#1988) 2021-05-20 22:24:46 +12:00
linting.yml ci: Fix lint check status update (#2224) 2021-09-29 09:13:58 +13:00
scheduled_builds.yml chore(deps): bump docker/metadata-action from 3.5.0 to 3.6.0 (#2258) 2021-10-26 12:08:19 +02:00
test_merge_requests.yml Streamline workflow step seperation (#2222) 2021-09-28 12:37:54 +02:00