add readme and stk validate action to pipe

Author: pedrohrfz

.github/workflows/stk-quality-check.yaml

@@ -1,18 +1,7 @@
 name: STK actions quality-check
 
 on:
-  workflow_call:
-    inputs:
-      realm:
-        description: The realm of the account.
-        required: false
-        type: string
-        default: "stackspot"
-    secrets:
-      stk-client-id:
-        required: true
-      stk-client-secret:
-        required: true
+  pull_request:
 
 jobs:
   stackspot-runtime-v2:
@@ -24,8 +13,13 @@ jobs:
       LC_ALL: C.UTF-8
       PYTHONIOENCODING: utf-8
     steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
       - run: sudo apt update && sudo apt install -y curl unzip git jq
         name: install dependencies
+      
       - name: Setup STK CLI
         run: |
           curl \
@@ -39,8 +33,14 @@ jobs:
             https://stk.stackspot.com/installer/linux/stk.deb
           sudo dpkg --install /tmp/stk.deb || echo installed
           rm --force /tmp/stk.deb
+
       - name: Show STK CLI  version
         run: $HOME/.stk/bin/stk --version
+      
       - name: Login StackSpot
         run: |
-          $HOME/.stk/bin/stk login -id ${{ secrets.stk-client-id }} -key ${{ secrets.stk-client-secret }} -r ${{ inputs.realm }}
+          $HOME/.stk/bin/stk login -id ${{ secrets.IDP_STK_CLIENT_ID }} -key ${{ secrets.IDP_STK_CLIENT_SECRET }} -r stackspot
+      
+      - name: Validate main action
+        run: |
+          $HOME/.stk/bin/stk validate action

README.md

@@ -11,4 +11,33 @@ Before using the actions in this repository, ensure that you have the following
 
 * StackSpot CLI installed and configured.
 
-
+## How to Use
+
+### Deploy
+
+```bash
+stk run action <path-where-u-cloned-the-repository> \
+    --workflow_type deploy \
+    --environment "<environment>" \
+    --version_tag "<version-tag>" \
+    --repository_name "<repository-name>" \
+    --client_id "<stackspot-client-id>" \
+    --client_key "<stackspot-client-key>" \
+    --client_realm "<stackspot-client-realm>" \
+    --aws_access_key_id "<aws-access-key-id>" \
+    --aws_secret_access_key "<aws-secret-access-key>" \
+    --aws_session_token "<aws-session-token>" \
+    --tf_state_bucket_name "<tf_state_bucket>" \
+    --iac_bucket_name "<iac_bucket_name>" \
+    --tf_state_region "<aws-region>" \
+    --iac_region "<aws-region>" \
+    --aws_region "<aws-region>"
+```
+
+### Cancel
+
+```bash
+stk run action <path-where-u-cloned-the-repository> \
+    --workflow_type cancel \
+    --run_id "<run_id>"
+```

action.yaml

@@ -13,7 +13,10 @@ spec:
   inputs:
     - label: Workflow type
       name: workflow_type
-      type: text
+      type: select
+      items:
+        - deploy
+        - cancel
       required: true
   python:
     workdir: .

script.py

@@ -42,7 +42,7 @@ def cancel_deploy_run(run_action: RunAction):
 
 
 def run(metadata):
-    workflows = dict(deploy=deploy_workflow, cancel_deploy=cancel_deploy_run)
+    workflows = dict(deploy=deploy_workflow, cancel=cancel_deploy_run)
     run_action = RunAction(metadata)
     workflow_runner = workflows.get(metadata.inputs["workflow_type"])
     workflow_runner and workflow_runner(run_action=run_action)