Skip to content

Commit a25268e

Browse files
committed
fix plan persistence documentation
1 parent e0b51f3 commit a25268e

File tree

4 files changed

+18
-8
lines changed

4 files changed

+18
-8
lines changed

docs/ce/features/plan-persistence.mdx

Lines changed: 0 additions & 5 deletions
This file was deleted.

docs/ce/howto/custom-commands.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ The value of `$DIGGER_OUT` defaults to `$RUNNER_TEMP/digger-out.log`; you can ch
4040

4141
## Overriding plan commands
4242

43+
<Note>
44+
This is an advanced usecase if you want to specify an entirely custom command during plan and apply phases. If you only want to use
45+
plan artefacts the easiest way would be to simply configure [plan artefacts persistence](/ce/howto/plan-artefacts) and you would not need to perform
46+
a complete override of the plan and apply commands.
47+
</Note>
4348
You can add extra arguments to the plan command by setting the `extra_args` key in the `steps` section of the `plan` command.
4449

4550
However in some cases if you wish to override the plan command entirely you can do it by excluding the plan in the steps and having your command specified in the run like so:

docs/ce/howto/store-plans-in-a-bucket.mdx renamed to docs/ce/howto/plan-artefacts.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,25 @@
11
---
2-
title: "Store plans in a Bucket"
2+
title: "Plan artefacts"
33
---
44

5+
Digger can be used to store plan artefacts during the plan phase and make them available for use during the apply phase. Once plan artefacts is configured and uploaded during the plan phase
6+
it will automatically be used during the apply phase. Once one of the below artefacts is configured successfully there is no additional configuration needed on your end to achieve apply-time artefact reuse.
7+
58
### Github
69
Digger can use Github Artifacts to store `terraform plan` outputs. In order to enable it you can set the following argument in digger_workflow.yml:
710

811
```
912
upload-plan-destination: github
1013
```
1114

15+
<Warning>
16+
Github plan artefacts as a destination is currently deprecated due to a change in Github API. For more information see [this issue](https://github.com/diggerhq/digger/issues/1702).
17+
</Warning>
18+
19+
<Alert>
20+
sadfasdf
21+
</Alert>
22+
1223
### GCP
1324
You can also configure plan outputs to be uploaded to GCP Buckets instead. This is handy in case you want your plan outputs to stay within your organisation's approved storage providers for security or compliance reasons.
1425

docs/mint.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@
7171
"ce/features/concurrency",
7272
"ce/features/layering",
7373
"ce/features/pr-level-locks",
74-
"ce/features/plan-persistence",
7574
"ce/features/private-runners",
7675
"ce/features/drift-detection",
7776
"ce/features/rbac",
@@ -104,7 +103,7 @@
104103
"ce/howto/policy-overrides",
105104
"ce/howto/project-level-roles",
106105
"ce/howto/segregate-cloud-accounts",
107-
"ce/howto/store-plans-in-a-bucket",
106+
"ce/howto/plan-artefacts",
108107
"ce/howto/trigger-directly",
109108
"ce/howto/using-checkov",
110109
"ce/howto/using-infracost",

0 commit comments

Comments
 (0)