[pull] main from githubocto:main

.github/workflows/dispatch.yml

@@ -0,0 +1,24 @@
+name: Repo Events Repository Dispatch
+
+on:
+  - issues
+  - issue_comment
+  - pull_request
+
+jobs:
+  preflight-job:
+    name: Dispatch
+    runs-on: ubuntu-latest
+    steps:
+      - name: Print Outputs
+        env:
+          outputs: ${{ toJSON(github) }}
+        run: |
+          echo outputs: $outputs
+      - name: Repository Dispatch
+        uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.PAT }} 
+          repository: githubocto/next-devex-workflows # repo to send event to
+          event-type: repoevents # name of the custom event
+          client-payload: '{"event": ${{ toJSON(github) }}}'

README.md

@@ -29,7 +29,7 @@ Check out our [example repositories](https://github.com/githubocto?q=flat-demo&t
 
 ### Option 1: Flat Editor VSCode Extension
 
-The easiest way to get a Flat Data action up and running is with the accompanying [Flat Editor VSCode Extension](https://marketplace.visualstudio.com/items?itemName=GitHubOCTO.flat) which helps you author Flat yml files. 
+The easiest way to get a Flat Data action up and running is with the accompanying [Flat Editor VSCode Extension](https://marketplace.visualstudio.com/items?itemName=GitHubOCTO.flat) which helps you author Flat yml files.
 
 To use it, [install the extension](https://marketplace.visualstudio.com/items?itemName=GitHubOCTO.flat) and then invoke `Flat Editor` from the command palette within VSCode (Mac: ⌘⇧P, Others:ctrl-shift-P).
 
@@ -56,13 +56,13 @@ jobs:
       - name: Setup deno
         uses: denoland/setup-deno@main
         with:
-          deno-version: v1.x
+          deno-version: v1.10.x
       # Check out the repository so it can read the files inside of it and do other operations
       - name: Check out repo
         uses: actions/checkout@v2
       # The Flat Action step. We fetch the data in the http_url and save it as downloaded_filename
       - name: Fetch data
-        uses: githubocto/flat@v2
+        uses: githubocto/flat@v3
         with:
           http_url: # THE URL YOU WISH TO FETCH GOES HERE
           downloaded_filename: # The http_url gets saved and renamed in our repository. Example: data.json, data.csv, image.png
@@ -85,20 +85,68 @@ These two modes are exclusive; you cannot mix settings for these two in one Flat
 
 #### `http_url`
 
-A URL from which to fetch data. Specifying this input puts Flat into `http` mode. 
+A URL from which to fetch data. Specifying this input puts Flat into `http` mode.
 
 This can be any endpoint: a json, csv, png, zip, xlsx, etc.
 
+#### `authorization` (optional)
+
+A string used for authorizing the HTTP request. The value of this field is passed in as a header w/ the `authorization` key.
+
+For example, if this field is set to `Bearer abc123` then the following header is sent with each request:
+
+```json
+{
+  "Authorization": "Bearer abc123"
+}
+```
+
+#### `axios_config` (optional)
+
+Under the hood, the `http` backend uses [Axios](https://github.com/axios/axios) for data fetching. By default, Flat assumes you're interested in using the `GET` method to fetch data, but if you'd like to `POST` (e.g., sending a GraphQL query), the `axios_config` option allows you to override this behavior.
+
+Specifically, the `axios_config` parameter should reflect a relative path to a `.json` file in your repository. This JSON file should mirror the shape of [Axios' request config parameters](https://github.com/axios/axios#request-config), with a few notable exceptions.
+
+- `url` and `baseURL` will both be ignored, as the `http_url` specified above will take precedence.
+- `headers` will be merged in with the authorization header described by the `authorization` parameter above. Please do not put secret keys here, as they will be stored in plain text!
+- All `function` parameters will be ignored (e.g., `transformRequest`).
+- The response type is always set to `responseType: 'stream'` in the background.
+
+An example `axios_config` might look thusly if you were interested in hitting GitHub's GraphQL API ([here is a demo](https://github.com/githubocto/flat-demo-graphql)) 👇
+
+```json
+{
+  "method": "post",
+  "data": {
+    "query": "query { repository(owner:\"octocat\", name:\"Hello-World\") { issues(last:20, states:CLOSED) { edges { node { title url labels(first:5) { edges { node { name } } } } } } } }"
+  }
+}
+```
+
+We advise escaping double quotes like `\"` in your JSON file.
+
 #### `downloaded_filename`
 
-The name of the file to store data fetched by Flat. 
+The name of the file to store data fetched by Flat.
 
 In `http` mode this can be anything. This can be any endpoint: a json, csv, txt, png, zip, xlsx, etc. file
 
 #### `postprocess` (optional)
 
 A path to a local Deno javascript or typescript file for postprocessing the `downloaded_filename` file. Read more in the ["Postprocessing section"](https://github.com/githubocto/flat#postprocessing).
 
+#### `mask` (optional)
+
+If your `http_url` string contains secrets, you can choose to mask it from the commit message. You have two options:
+
+**Option 1**: use a string boolean
+
+`mask: true # removes the source entirely from the commit message, defaults to false`
+
+**Option 2**: use a string array with each secret to mask
+
+`mask: '["${{ secrets.SECRET1 }}", "${{ secrets.SECRET2 }}"]'`
+
 ### SQL Mode
 
 #### `sql_connstring`
@@ -115,19 +163,30 @@ A URI-style database connection string. Flat will use this connection string to
 >
 > If you're using the [flat-vscode extension](https://github.com/githubocto/flat-vscode), this is handled for you.
 
-
 #### `sql_queryfile`
 
 The pathname of the file containing the SQL query that will be issued to the database. Defaults to `.github/workflows/query.sql`. This path is relative to the root of your repo.
 
 #### `downloaded_filename`
 
-The name of the file to store data fetched by Flat. 
+The name of the file to store data fetched by Flat.
 
 In `sql` mode this should be one of `csv` or `json`. SQL query results will be serialized to disk in the specified format.
 
 > ⚠️ While the JSON is not pretty-printed, CSV is often a more efficient serialization for tabular data.
 
+#### `typeorm_config` (optional)
+
+A JSON string representing a configuration passed to [TypeORMs createConnection function](https://orkhan.gitbook.io/typeorm/docs/connection-api#main-api).
+
+A common use case for this value is connecting your [Flat action to a Heroku database](https://github.com/typeorm/typeorm/issues/278).
+
+For instance, you can pass the following configuration string to your Flat action in order to connect to a Heroku Postgres database.
+
+```yaml
+typeorm_config: '{"ssl":true,"extra":{"ssl":{"rejectUnauthorized":false}}}'
+```
+
 #### `postprocess` (optional)
 
 A path to a local Deno javascript or typescript file for postprocessing the `downloaded_filename` file. Read more in the ["Postprocessing section"](https://github.com/githubocto/flat#postprocessing).
@@ -142,7 +201,7 @@ A signed number describing the number of bytes that changed in this run. If the
 
 You can add a `postprocess` input in the Action which is path to a [deno](https://deno.land) Javascript or Typescript script that will be invoked to postprocess your data after it is fetched. This path is relative to the root of your repo.
 
-The script can use either `Deno.args[0]` or the name of the `downloaded_filename` to access the file fetched by Flat Data. 
+The script can use either `Deno.args[0]` or the name of the `downloaded_filename` to access the file fetched by Flat Data.
 
 ```ts
 import { readJSON, writeJSON } from 'https://deno.land/x/flat/mod.ts'

action.yml

@@ -2,6 +2,9 @@ name: 'Flat Data'
 description: 'The GitHub action which powers data fetching for Flat'
 author: 'GitHub OCTO'
 inputs:
+  axios_config:
+    description: 'A path (relative to the root of your repo) of a JSON file containing a subset of Axios configuration'
+    required: false
   downloaded_filename:
     description: 'The filename to use for writing data.'
     required: false
@@ -11,21 +14,27 @@ inputs:
   authorization:
     description: 'A string to send as a header for authorizing API requests.'
     required: false
+  mask:
+    description: 'A string array of secrets to strip from the http_url or a string boolean'
+    required: false
   sql_connstring:
     description: 'A connection string for making a SQL query.'
     required: false
   sql_queryfile:
     description: 'A path (relative to the root of your repo) of a SQL query file to execute for fetching data.'
     required: false
     default: '.github/workflows/query.sql'
+  typeorm_config:
+    description: 'A JSON string representing a configuration passed to TypeORMs createConnection function'
+    required: false
   postprocess:
     description: 'A path (relative to the root of your repo) or a URL to a deno postprocessing script.'
     required: false
 outputs:
   delta_bytes: # size of changed data
     description: The overall number of bytes changed in the output data this run (current size - previous size)
 runs:
-  using: 'node12'
+  using: 'node16'
   main: 'dist/index.js'
   post: 'dist/post/index.js'
 branding: