Merge pull request #95 from dflook/optional-path

Use the action workspace by default

Author: dflook

.github/workflows/test-plan.yaml

@@ -329,3 +329,20 @@ jobs:
           TERRAFORM_PRE_RUN: |
             echo "testing command 1"
             echo "testing command 2"
+
+  default_path:
+    runs-on: ubuntu-latest
+    name: Default path
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Copy
+        run: cp tests/plan/plan/main.tf ./main.tf
+
+      - name: Plan
+        uses: ./terraform-plan
+        with:
+          label: Optional path

image/tools/github_pr_comment.py

@@ -18,8 +18,8 @@
 github_url = os.environ.get('GITHUB_SERVER_URL', 'https://github.com')
 github_api_url = os.environ.get('GITHUB_API_URL', 'https://api.github.com')
 
-def github_api_request(method, *args, **kw_args):
-    response = github.request(method, *args, **kw_args)
+def github_api_request(method, *args, **kwargs):
+    response = github.request(method, *args, **kwargs)
 
     if 400 <= response.status_code < 500:
         debug(str(response.headers))
@@ -49,21 +49,23 @@ def debug(msg: str) -> None:
     sys.stderr.write(msg)
     sys.stderr.write('\n')
 
-def prs(repo: str) -> Iterable[Dict]:
-    url = f'{github_api_url}/repos/{repo}/pulls'
+def paginate(url, *args, **kwargs) -> Iterable[Dict]:
 
     while True:
-        response = github_api_request('get', url, params={'state': 'all'})
+        response = github_api_request('get', url, *args, **kwargs)
         response.raise_for_status()
 
-        for pr in response.json():
-            yield pr
+        yield from response.json()
 
         if 'next' in response.links:
             url = response.links['next']['url']
         else:
             return
 
+def prs(repo: str) -> Iterable[Dict]:
+    url = f'{github_api_url}/repos/{repo}/pulls'
+    yield from paginate(url, params={'state': 'all'})
+
 
 def find_pr() -> str:
     """
@@ -152,13 +154,12 @@ def __init__(self, pr_url: str=None):
         response.raise_for_status()
 
         self._issue_url = response.json()['_links']['issue']['href'] + '/comments'
-        response = github_api_request('get', self._issue_url)
-        response.raise_for_status()
 
         username = current_user()
 
         debug('Looking for an existing comment:')
-        for comment in response.json():
+
+        for comment in paginate(self._issue_url):
             debug(json.dumps(comment))
             if comment['user']['login'] == username:
                 match = re.match(rf'{re.escape(self._comment_identifier)}.*```(?:hcl)?(.*?)```.*', comment['body'], re.DOTALL)

terraform-apply/README.md

@@ -38,7 +38,8 @@ These input values must be the same as any `terraform-plan` for the same configu
   Path to the terraform configuration to apply
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 * `workspace`
 

terraform-apply/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
   workspace:
     description: Name of the terraform workspace
     required: false

terraform-check/README.md

@@ -13,7 +13,8 @@ This is intended to run on a schedule to notify if manual changes to your infras
   Path to the terraform configuration to check
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 * `workspace`
 

terraform-check/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
   workspace:
     description: Name of the terraform workspace
     required: false

terraform-destroy-workspace/README.md

@@ -11,7 +11,8 @@ This action uses the `terraform destroy` command to destroy all resources in a t
   Path to the terraform configuration
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 * `workspace`
 

terraform-destroy-workspace/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
   workspace:
     description: Name of the terraform workspace
     required: true

terraform-destroy/README.md

@@ -12,7 +12,8 @@ This action uses the `terraform destroy` command to destroy all resources in a t
   Path to the terraform configuration
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 * `workspace`
 

terraform-destroy/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
   workspace:
     description: Name of the terraform workspace
     required: false

terraform-fmt-check/README.md

@@ -14,7 +14,8 @@ If any files are not correctly formatted a failing GitHub check will be added fo
   Path to the terraform configuration
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 ## Example usage
 

terraform-fmt-check/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
 
 runs:
   using: docker

terraform-fmt/README.md

@@ -11,7 +11,8 @@ This action uses the `terraform fmt` command to reformat files in a directory in
   Path to the terraform configuration
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 ## Example usage
 

terraform-fmt/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
 
 runs:
   using: docker

terraform-new-workspace/README.md

@@ -11,7 +11,8 @@ Creates a new terraform workspace. If the workspace already exists, succeeds wit
   Path to the terraform configuration
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 * `workspace`
 

terraform-new-workspace/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
   workspace:
     description: Name of the terraform workspace
     required: true

terraform-output/README.md

@@ -11,7 +11,8 @@ Retrieve the root-level outputs from a terraform configuration.
   Path to the terraform configuration
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 * `workspace`
 

terraform-output/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
   workspace:
     description: Name of the terraform workspace
     required: false

terraform-plan/README.md

@@ -21,7 +21,8 @@ The [dflook/terraform-apply](https://github.com/dflook/terraform-github-actions/
   Path to the terraform configuration
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 * `workspace`
 

terraform-plan/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
   workspace:
     description: Name of the terraform workspace
     required: false

terraform-validate/README.md

@@ -20,7 +20,8 @@ If the terraform configuration is not valid, the build is failed.
   Path to the terraform configuration
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 ## Environment Variables
 

terraform-validate/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
 
 runs:
   using: docker

terraform-version/README.md

@@ -25,7 +25,8 @@ outputs yourself.
   Path to the terraform configuration to apply
 
   - Type: string
-  - Required
+  - Optional
+  - Default: The action workspace
 
 ## Environment Variables
 

terraform-version/action.yaml

@@ -5,7 +5,8 @@ author: Daniel Flook
 inputs:
   path:
     description: Path to the terraform configuration
-    required: true
+    required: false
+    default: .
 
 outputs:
   version: