From 91e77255fe5fe2cc9eaea6c39a259e51d405c816 Mon Sep 17 00:00:00 2001 From: Sarvar Muminov Date: Thu, 18 Mar 2021 13:06:46 -0700 Subject: [PATCH] Updating the docs After #1418 was merged pre-workflow-hooks are executed before every command. Removed the note and added some more explanation to the docs --- runatlantis.io/docs/pre-workflow-hooks.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/runatlantis.io/docs/pre-workflow-hooks.md b/runatlantis.io/docs/pre-workflow-hooks.md index dee974e17f..89d50d0d8c 100644 --- a/runatlantis.io/docs/pre-workflow-hooks.md +++ b/runatlantis.io/docs/pre-workflow-hooks.md @@ -1,14 +1,13 @@ # Pre Workflow Hooks -Pre workflow hooks can be defined to run scripts right before default or custom -workflows are executed. - -::: tip Note -Defined pre workflow hooks will be executed only once when a new pull -request is opened, and later only if this pull request has been updated. -The pre workflow hooks are not run on manual `atlantis plan` or -`atlantis apply` commands. -::: +Pre workflow hooks can be defined to run scripts before default or custom +workflows are executed. Pre workflow hooks differ from [custom +workflows](custom-workflows.html#custom-run-command) in several ways. + +1. Pre workflow hooks do not require for repository configuration to be + present. This be utilized to [dynamically generate repo configs](pre-workflow-hooks.html#dynamic-repo-config-generation). +2. Pre workflow hooks are ran outside of Atlantis commands. Which means + they do not surface their output back to the PR as a comment. [[toc]]