Skip to content

Commit

Permalink
Merge pull request #1078 from diggerhq/docs/plan-file-naming
Browse files Browse the repository at this point in the history
Docs: add plan json file naming
  • Loading branch information
ZIJ authored Jan 22, 2024
2 parents ef42940 + 7fe4d65 commit 8bd8e6d
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/features/plan-persistence.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,14 @@ Or to use a GCP bucket:
```
upload-plan-destination: gcp
```

## Plan json file naming convention

The location of plan json output file is `${GITHUB_WORKSPACE}/${GITHUB_ORG}-${REPO}#${DIGGER_PROJECT}.tfplan

Note that `$GIHTUB_WORKSPACE` may contain repo name twice; it also may contain the project directory e.g "dev" because the workdir is relative to project. Repo name is then appended for the 3rd time between org name and project name. So the final file path for a repo named "myrepo" with a project named "development" at `/dev` may look like this:

```
/home/runner/work/myrepo/myrepo/dev/diggerhq-myrepo#development.tfplan
```

0 comments on commit 8bd8e6d

Please sign in to comment.