Skip to content

Commit

Permalink
Document scaffold command
Browse files Browse the repository at this point in the history
  • Loading branch information
mraerino committed Jun 30, 2024
1 parent f55a172 commit 0cdb760
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 @@ -108,6 +108,23 @@ sudo mv tf-preview-gh /usr/local/bin/tf-preview-gh
sudo chmod +x /usr/local/bin/tf-preview-gh
```

### Configure

In order to use it with your respository, you need to have some workflows in place.

The `tf-preview-gh scaffold` command sets up everything that's necessary. This includes the workflows to run plans for pull requests and applies for merges to main.

It should look like this:

```
% tf-preview-gh scaffold
Wrote backend config to: backend.tf
Wrote workflow to: .github/workflows/tf-preview.yaml
Wrote workflow to: .github/workflows/tf-run.yaml
```

Next, commit the new files and get them on main before continuing.

### Usage

Run the CLI in the directory for which you want to run a remote plan.
Expand Down

0 comments on commit 0cdb760

Please sign in to comment.