Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
marcportabellaclotet-mt committed Oct 13, 2023
1 parent 59953b2 commit f2e8e13
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,8 @@ Run the tool using the following command:

*When you run this command within an Atlantis workflow, it will make an effort to automatically identify the GitHub token by extracting it from the URL in the .git/config file.*

*When you run this command within an Atlantis workflow, `base-repo` `base-repo-owner` and `pull-num parameters will be automatically identified.*

-------

**Workflows**
Expand Down Expand Up @@ -113,6 +115,21 @@ func detectProjectWorkspaces(foldersList []ProjectFolder, workflow string, patte

-------

**Atlantis integration**
-------------

Incorporating this generator into Atlantis requires setting up a [`pre-workflow-run`](https://www.runatlantis.io/docs/pre-workflow-hooks.html) as follows:

```yaml
pre_workflow_hooks:
- run: >
atlantis-yaml-generator -w single-workspace --pattern-detector main.tf
```
Additionally, it's essential to ensure that the atlantis-yaml-generator binary is included on your Atlantis server.
-------
**Build**
---------
Expand Down

0 comments on commit f2e8e13

Please sign in to comment.