Skip to content

Commit 8bd8e6d

Browse files
authored
Merge pull request #1078 from diggerhq/docs/plan-file-naming
Docs: add plan json file naming
2 parents ef42940 + 7fe4d65 commit 8bd8e6d

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/features/plan-persistence.mdx

+11
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,14 @@ Or to use a GCP bucket:
1212
```
1313
upload-plan-destination: gcp
1414
```
15+
16+
## Plan json file naming convention
17+
18+
The location of plan json output file is `${GITHUB_WORKSPACE}/${GITHUB_ORG}-${REPO}#${DIGGER_PROJECT}.tfplan
19+
20+
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:
21+
22+
```
23+
/home/runner/work/myrepo/myrepo/dev/diggerhq-myrepo#development.tfplan
24+
```
25+

0 commit comments

Comments
 (0)