You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+26-2Lines changed: 26 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,7 +62,7 @@ jobs:
62
62
uses: actions/checkout@v2
63
63
# The Flat Action step. We fetch the data in the http_url and save it as downloaded_filename
64
64
- name: Fetch data
65
-
uses: githubocto/flat@v2
65
+
uses: githubocto/flat@v3
66
66
with:
67
67
http_url: # THE URL YOU WISH TO FETCH GOES HERE
68
68
downloaded_filename: # The http_url gets saved and renamed in our repository. Example: data.json, data.csv, image.png
@@ -114,6 +114,18 @@ In `http` mode this can be anything. This can be any endpoint: a json, csv, txt,
114
114
115
115
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).
116
116
117
+
#### `mask` (optional)
118
+
119
+
If your `http_url` string contains secrets, you can choose to mask it from the commit message. You have two options:
120
+
121
+
**Option 1**: use a string boolean
122
+
123
+
`mask: true # removes the source entirely from the commit message, defaults to false`
124
+
125
+
**Option 2**: use a string array with each secret to mask
@@ -142,6 +154,18 @@ In `sql` mode this should be one of `csv` or `json`. SQL query results will be s
142
154
143
155
> ⚠️ While the JSON is not pretty-printed, CSV is often a more efficient serialization for tabular data.
144
156
157
+
#### `typeorm_config` (optional)
158
+
159
+
A JSON string representing a configuration passed to [TypeORMs createConnection function](https://orkhan.gitbook.io/typeorm/docs/connection-api#main-api).
160
+
161
+
A common use case for this value is connecting your [Flat action to a Heroku database](https://github.com/typeorm/typeorm/issues/278).
162
+
163
+
For instance, you can pass the following configuration string to your Flat action in order to connect to a Heroku Postgres database.
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).
@@ -156,7 +180,7 @@ A signed number describing the number of bytes that changed in this run. If the
156
180
157
181
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.
158
182
159
-
The script can use either `Deno.args[0]` or the name of the `downloaded_filename` to access the file fetched by Flat Data.
183
+
The script can use either `Deno.args[0]` or the name of the `downloaded_filename` to access the file fetched by Flat Data.
160
184
161
185
```ts
162
186
import { readJSON, writeJSON } from 'https://deno.land/x/flat/mod.ts'
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
2137
+
Permission is hereby granted, free of charge, to any person obtaining a copy
2138
+
of this software and associated documentation files (the "Software"), to deal
2139
+
in the Software without restriction, including without limitation the rights
2140
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
2141
+
copies of the Software, and to permit persons to whom the Software is
2142
+
furnished to do so, subject to the following conditions:
2085
2143
2086
-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
2144
+
The above copyright notice and this permission notice shall be included in
2145
+
all copies or substantial portions of the Software.
2087
2146
2088
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2147
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
2148
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
2149
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
2150
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
2151
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2152
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
2153
+
THE SOFTWARE.
2089
2154
2090
2155
2091
2156
is-typedarray
@@ -2110,6 +2175,9 @@ IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
2110
2175
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
2111
2176
2112
2177
2178
+
isarray
2179
+
MIT
2180
+
2113
2181
isstream
2114
2182
MIT
2115
2183
The MIT License (MIT)
@@ -2751,6 +2819,31 @@ ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
2751
2819
IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
3904
+
Permission is hereby granted, free of charge, to any person obtaining a copy
3905
+
of this software and associated documentation files (the "Software"), to deal
3906
+
in the Software without restriction, including without limitation the rights
3907
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
3908
+
copies of the Software, and to permit persons to whom the Software is
3909
+
furnished to do so, subject to the following conditions:
3766
3910
3767
-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
3911
+
The above copyright notice and this permission notice shall be included in
3912
+
all copies or substantial portions of the Software.
3768
3913
3769
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
3914
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
3915
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
3916
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
3917
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
3918
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
3919
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
3920
+
THE SOFTWARE.
3770
3921
3771
3922
3772
3923
string_decoder
@@ -4081,6 +4232,21 @@ FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
4081
4232
OTHER DEALINGS IN THE SOFTWARE.
4082
4233
4083
4234
4235
+
uri-js
4236
+
BSD-2-Clause
4237
+
Copyright 2011 Gary Court. All rights reserved.
4238
+
4239
+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4240
+
4241
+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
4242
+
4243
+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
4244
+
4245
+
THIS SOFTWARE IS PROVIDED BY GARY COURT "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GARY COURT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
4246
+
4247
+
The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of Gary Court.
0 commit comments