action to update settings for rapidpro workspace

Gruntfile.js

@@ -303,6 +303,7 @@ module.exports = function(grunt) {
             'config/**/*.js',
             'scripts/**/*.js',
             'webapp/src/ts/**/*.component.html',
+            'gh-actions/**/*.js',
           ];
           const ignore = [
             'webapp/src/ts/providers/xpath-element-path.provider.ts',

gh-actions/dynamic-rapidpro-workspace-settings/README.md

@@ -0,0 +1,82 @@
+# dynamic-rapidpro-workspace Shared GitHub Action
+The `dynamic-rapidpro-workspace-settings` is a parameterised reusable GitHub action that updates app-settings prior to compiling and uploading to a running CHT app.
+
+### Background
+This action is relevant for CHT apps that have either [outbound](https://docs.communityhealthtoolkit.org/apps/reference/app-settings/outbound/) integrations with RapidPro or logic that requires RapidPro workspace data GUIDs.
+Normally, you would want a staging deployment to use the staging workspace and a production deployment to use the corresponding production workspace. This action automates the process of updating `app_settings.json` to use relevant UUIDs.
+
+### How it works
+1. It adds the configured `value_key` to CouchDB’s config storage to securely store the [credentials](https://docs.communityhealthtoolkit.org/apps/reference/app-settings/outbound/#credentials).
+2. This action automatically updates the following details in outbound modules:
+   - `base_url` and `value_key`
+   - contact group UUID, if using the [groups endpoint](https://rapidpro.app.medicmobile.org/api/v2/groups). Note that the action was tested with one group.
+   - flow UUID, if using the [flow starts endpoint](https://rapidpro.app.medicmobile.org/api/v2/flow_starts). Note that the action was tested with one flow in two modules.
+3. It replaces contents of a file, `flows.js`, in the project repository with flow UUIDs obtained from RapidPro workspace through the API. To extract the UUIDs, you can simply use the API explorer, under `/api/v2/flows.json`. A sample `flows.js` would be as follows:
+
+```
+module.exports = {
+  sample_flow_1_uuid: '3f6a48d3-703a-493b-bb10-f4a38a442cda',
+  sample_flow_2_uuid: '064107cf-9bc5-4042-a657-825fdb5a92a4',
+  ...
+};
+```
+
+> **This action can be executed jointly with other Github actions like [deploy-with-medic-conf](https://github.com/medic/cht-core/tree/master/.github/actions/deploy-with-medic-conf). However, it must be executed before other actions to update dependencies prior to compiling app settings.** 
+
+## CHT App Requirements
+* cht-conf@3.3 or above
+
+## Example GitHub Action Step
+
+```
+name: Example GitHub Workflow yml
+
+on: ['workflow_dispatch']
+
+jobs:
+  workflow_dispatch:
+    runs-on: ubuntu-18.04
+
+    steps:
+    - name: Update rapidpro workspace in app-settings 
+      uses: 'medic/gh-actions/dynamic-rapidpro-workspace-settings@main'
+      with:
+        directory: 'my_app_folder'
+        hostname: myapp.staging.company.org
+        couch_node_name: myapp.couchdb.node.name
+        couch_username: ${{ secrets.CHT_STAGING_USERNAME }}
+        couch_password: ${{ secrets.CHT_STAGING_PASSWORD }}
+        rp_hostname: my.rapidpro.workspace.url
+        rp_api_token: ${{ secrets.RAPIDPRO_STAGING_TOKEN }}
+        value_key: medic.credentials.key
+        rp_contact_group: ${{ secrets.RAPIDPRO_STAGING_GROUP }}
+        rp_flows: ${{ secrets.RAPIDPRO_STAGING_FLOWS }}
+        write_patient_state_flow: ${{ secrets.RAPIDPRO_STAGING_WRITE_PATIENT_STATE_FLOW }}
+        app_settings_file: app_settings.json
+        flows_file: flows.js
+```
+
+### Example Action Input Variables From RapidPro Workspace
+
+#### token
+```
+Token cb9affcf72f787d6f0413a3394f32e8cfff0f8ec
+```
+
+#### group
+```
+79abde8c-5f65-4e04-9ee1-4cecdc8852e1
+```
+
+#### flows
+```
+{
+  sample_flow_1_uuid: '3f6a48d3-703a-493b-bb10-f4a38a442cda',
+  sample_flow_2_uuid: '064107cf-9bc5-4042-a657-825fdb5a92a4',
+  ...
+}
+```
+#### write_patient_state_flow
+```
+c80848e1-72f3-4e86-8e9e-ce002bee4906
+```

gh-actions/dynamic-rapidpro-workspace-settings/action.yml

@@ -0,0 +1,59 @@
+name: 'Update rapidpro workspace settings'
+inputs:
+  directory:
+    description: The path to the directory containing the configuration to be updated.
+    required: true
+    default: '.'
+
+  hostname:
+    description: The hostname of the instance to receive the configuration.
+    required: true
+
+  couch_node_name:
+    description: The name of your CouchDB's node.
+    required: true
+
+  couch_username:
+    description: The username of an administrator account on the instance at "inputs.hostname". This user will make the deployment.
+    required: true
+
+  couch_password:
+    description: The password for user with name "inputs.couch_username"
+    required: true
+
+  rp_hostname:
+    description: The base URL for your Rapidpro workspace.
+    required: true
+
+  rp_api_token:
+    description: The authorization token for your workspace (the real password configured in CouchDB's admin config).
+    required: true
+
+  value_key:
+    description: The password key configured in CouchDB's admin config.
+    required: true
+
+  rp_contact_group:
+    description: The UUID of the contact group to update in app-settings (optional).
+    required: true
+
+  rp_flows:
+    description: The list of flows for your workspace.
+    required: true
+
+  write_patient_state_flow:
+    description: The UUID of the flow to write patient state.
+    required: true
+
+outputs:
+  app-settings: 
+    description: Updated app-settings.json
+    value: ${{ steps.update-app-settings.outputs }}
+
+  rp_flows: 
+    description: A flows.js file to be used in compile-app-settings
+    value: ${{ steps.generate-flows-js.outputs }}
+
+runs:
+  using: 'node12'
+  main: 'dist/index.js'