merge develop into feat/lowlevel-run (#1097)

* Docs - Update feedback.mdx * Docs - Update feedback.mdx * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Documentation edits made through Mintlify web editor * Add actions:write permission to AWS quickstart * Add action permissions to GCP quickstart * Docs: add permissions to plan-persistence page * Docs: add comment-id to workflow file in quickstarts * Update github-actions-and-gcp.mdx --------- Co-authored-by: Utpal Nadiger <nadiger.utpal@gmail.com> Co-authored-by: Igor Zalutski <izalutski@gmail.com>
diggerhq · Jan 31, 2024 · 0e49f41 · 0e49f41
1 parent 72c3f7d
commit 0e49f41
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 4 deletions.
diff --git a/docs/features/plan-persistence.mdx b/docs/features/plan-persistence.mdx
@@ -13,6 +13,9 @@ Or to use a GCP bucket:
 upload-plan-destination: gcp
 ```
 
+## Permissions
+Make sure to set `actions:write` permission in your workflow; otherwise plan storage might fail
+
 ## Plan json file naming convention
 
 The location of plan json output file is:

diff --git a/docs/getting-started/github-actions-+-aws.mdx b/docs/getting-started/github-actions-+-aws.mdx
@@ -36,11 +36,14 @@ on:
         required: false
       job:
         required: true
+      comment_id:
+        required: true
 jobs:
   digger-job:
     runs-on: ubuntu-latest
     permissions:    
       contents: write      # required to merge PRs
+      actions: write       # required for plan persistence
       id-token: write      # required for workload-identity-federation
       pull-requests: write # required to post PR comments
       statuses: write      # required to validate combined PR status

diff --git a/docs/getting-started/github-actions-and-gcp.mdx b/docs/getting-started/github-actions-and-gcp.mdx
@@ -36,10 +36,18 @@ on:
         required: false
       job:
         required: true
+      comment_id:
+        required: true
 jobs:
   digger-job:
     name: Digger
     runs-on: ubuntu-latest
+    permissions:    
+      contents: write      # required to merge PRs
+      actions: write       # required for plan persistence
+      id-token: write      # required for workload-identity-federation
+      pull-requests: write # required to post PR comments
+      statuses: write      # required to validate combined PR status
     steps:
     - uses: actions/checkout@v4
     - id: 'auth'

diff --git a/docs/readme/feedback.mdx b/docs/readme/feedback.mdx
@@ -1,12 +1,15 @@
 ---
-title: "Feedback - tell us what is lacking"
+title: "Feedback"
 ---
 
 We are always looking at feedback and suggestions from the community. If something is missing, if you have a feature request, or if something isn't working as it is supposed to,
 please tell us. We are always keen on thoughts/feedback.
 
-Please head over to this page on [github](https:github.com/diggerhq/digger/docs/readme/feedback) and raise a PR to add your feedback with the following syntax
 
-{Sl no}.{Name} - [Feedback point](Optionally link corresponding GitHub Issue if it exists}
+Head over to [Github](https://github.com/diggerhq/digger/blob/develop/docs/readme/feedback.mdx) and raise a PR to add your feedback below (Optionally link to a github issue if you find it is relevant to your feedback)
 
-1. Utpal Nadiger - [terraform file for the initial configuration to setup S3 & Dynamo DB for state management](https://github.com/diggerhq/digger/issues/206)
+## To-do list (Issues, feedback and feature requests)
+
+1. Terraform file for the initial condiguration to setup S3 bucket and dynamo DB for [state management](https://github.com/diggerhq/digger/issues/206).
+
+2. Decouple auth from [frontegg](https://github.com/diggerhq/digger/issues/1074).