8 releases (stable)
new 1.4.0 | Mar 20, 2023 |
---|---|
1.3.0 | Jan 14, 2023 |
1.0.14 | Dec 23, 2022 |
0.1.0 | Dec 20, 2022 |
#143 in Command line utilities
23 downloads per month
24KB
490 lines
json2file
Generate file output from a JSON string.
Usage
...
- name: Set output
id: set-output
run: |
echo "color=green" >> $GITHUB_OUTPUT
- name: Generate file output from json
uses: tj-actions/json2file@v1
with:
directory: 'output'
outputs: ${{ toJSON(steps.set-output.outputs) }}
keys: 'color'
extension: 'txt'
...
The above example will create a file named color.txt
in the output
directory with the contents green
.
$ cat ./output/color.txt
green
Inputs
INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
---|---|---|---|---|
bin_path | string | false | Path to the binary | |
directory | string | true | ".github/outputs" |
Directory to write to |
extension | string | false | "txt" |
File extension to use |
keys | string | true | List of Keys to read from the outputs JSON string |
|
outputs | string | true | JSON string | |
skip_missing_keys | string | false | "false" |
Skip missing keys not found in the outputs JSON string |
CLI Reference
Run json2file --help
for more information.
$ json2file --help
Generate file output from JSON
Usage: json2file [OPTIONS] --keys <KEYS> --outputs <OUTPUTS> --directory <DIRECTORY>
Options:
-k, --keys <KEYS> Space delimited list of keys to extract from the JSON output
-o, --outputs <OUTPUTS> The JSON output to use
-d, --directory <DIRECTORY> The directory to output the files to
-s, --skip-missing-keys Skip missing keys
-e, --extension <EXTENSION> The extension to use for the files [default: txt] [possible values: txt, json]
-v, --verbose
-h, --help Print help
-V, --version Print version
Example
$ json2file --keys="foo bar" --outputs="{\"foo\": \"value1\", \"bar\": \"value2\"}" --directory=/tmp --extension=txt
This creates two files with the following contents:
foo.txt
value1
bar.txt
value2
- Free software: MIT license
If you feel generous and want to show some extra appreciation:
Credits
This package was created with Cookiecutter using cookiecutter-action
Report Bugs
Report bugs at https://github.com/tj-actions/json2file/issues.
If you are reporting a bug, please include:
- Your operating system name and VERSION.
- Any details about your workflow that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Dependencies
~3–4MB
~95K SLoC