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

Updating the pre workflow hooks docs #1465

Merged
merged 1 commit into from
Mar 18, 2021
Merged

Updating the pre workflow hooks docs #1465

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
17 changes: 8 additions & 9 deletions runatlantis.io/docs/pre-workflow-hooks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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]]

Expand Down