https://github.com/yakubique/json-utils
A collection of handy utilities for working with JSON in GitHub Actions, making it easier to manipulate JSON data
https://github.com/yakubique/json-utils
github-actions json lodash processing
Last synced: 3 months ago
JSON representation
A collection of handy utilities for working with JSON in GitHub Actions, making it easier to manipulate JSON data
- Host: GitHub
- URL: https://github.com/yakubique/json-utils
- Owner: yakubique
- License: mit
- Created: 2024-02-02T05:11:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-24T08:16:49.000Z (almost 2 years ago)
- Last Synced: 2025-03-20T15:17:46.773Z (over 1 year ago)
- Topics: github-actions, json, lodash, processing
- Language: TypeScript
- Homepage:
- Size: 233 KB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# json-utils
A collection of handy utilities for working with JSON in GitHub Actions, making it easier to manipulate JSON data
For live examples, please see [actions](https://github.com/yakubique/json-utils/actions/workflows/test-myself.yaml)
**Methods**:
- [Diff](#diff)
- [Sort](#sort)
- [Pick](#pick)
- [Get](#get)
- [Concat](#concat)
- [Chunk](#chunk)
- [None](#none)
## Diff
### Flat
Order and values are taken from `input`. In this case it's `["1.3.0"]`
```yaml
uses: yakubique/json-utils@v1.8
with:
input: '["1.0.0","1.1.0","1.2.0","1.2.1","1.3.0"]'
secondary: '["1.0.0","1.1.0","1.2.0","1.2.1"]'
action: "diff"
# result: "["1.3.0"]"
```
It'll return nothing if change direction
```yaml
uses: yakubique/json-utils@v1.8
with:
input: '["1.0.0","1.1.0","1.2.0","1.2.1"]'
secondary: '["1.0.0","1.1.0","1.2.0","1.2.1","1.3.0"]'
action: "diff"
# result: "[]"
```
### With nested json
Find diff using `name` field in object
```yaml
uses: yakubique/json-utils@v1.8
with:
input: '[{"name":"v0.3.26","tag_name":"v0.3.26","prerelease":false,"published_at":"2023-08-07T09:43:28Z"},{"name":"v0.3.22","tag_name":"v0.3.22","prerelease":false,"published_at":"2023-11-12T10:58:00Z"},{"name":"v0.3.23","tag_name":"v0.3.23","prerelease":false,"published_at":"2023-11-12T10:59:27Z"},{"name":"v0.3.25","tag_name":"v0.3.25","prerelease":false,"published_at":"2023-11-12T11:01:20Z"},{"name":"v0.3.31","tag_name":"v0.3.31","prerelease":false,"published_at":"2023-11-12T11:17:17Z"},{"name":"v0.3.34","tag_name":"v0.3.34","prerelease":false,"published_at":"2023-11-12T11:21:59Z"}]'
secondary: '[{"name":"v0.3.26","tag_name":"v0.3.26","prerelease":false,"published_at":"2023-08-07T09:43:28Z"},{"name":"v0.3.22","tag_name":"v0.3.22","prerelease":false,"published_at":"2023-11-12T10:58:00Z"},{"name":"v0.3.23","tag_name":"v0.3.23","prerelease":false,"published_at":"2023-11-12T10:59:27Z"},{"name":"v0.3.25","tag_name":"v0.3.25","prerelease":false,"published_at":"2023-11-12T11:01:20Z"},{"name":"v0.3.31","tag_name":"v0.3.31","prerelease":false,"published_at":"2023-11-12T11:17:17Z"}]'
action: "diff"
type: "nested-json"
key: "name"
# result: "[{"name":"v0.3.34","tag_name":"v0.3.34","prerelease":false,"published_at":"2023-11-12T11:21:59Z"}]"
```
### Use output
```yaml
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Diff two arrays
id: diff_two_arrays
uses: yakubique/json-utils@v1.8
with:
input: '["1.0.0","1.1.0","1.2.0","1.2.1","1.3.0"]'
secondary: '["1.0.0","1.1.0","1.2.0","1.2.1"]'
action: "diff"
- name: Test 1
run: |
echo "Expecting ['1.3.0']"
echo "${{ steps.diff_two_arrays.outputs.result }}"
test "${{ steps.diff_two_arrays.outputs.result }}" == "[1.3.0]"
```
## Sort
### Flat
By default it's `Ascending`
```yaml
uses: yakubique/json-utils@v1.8
with:
input: '["1.0.0","1.1.0","1.2.0","1.2.1","1.3.0"]'
action: "sort"
```
`Descending`
```yaml
uses: yakubique/json-utils@v1.8
with:
input: '["1.0.0","1.1.0","1.2.0","1.2.1","1.3.0"]'
action: "sort"
modifier: "desc"
```
### With nested json
Find diff using `name` field in object
```yaml
uses: yakubique/json-utils@v1.8
with:
input: '[{"name":"v0.3.26","tag_name":"v0.3.26","prerelease":false,"published_at":"2023-08-07T09:43:28Z"},{"name":"v0.3.22","tag_name":"v0.3.22","prerelease":false,"published_at":"2023-11-12T10:58:00Z"},{"name":"v0.3.23","tag_name":"v0.3.23","prerelease":false,"published_at":"2023-11-12T10:59:27Z"},{"name":"v0.3.25","tag_name":"v0.3.25","prerelease":false,"published_at":"2023-11-12T11:01:20Z"},{"name":"v0.3.31","tag_name":"v0.3.31","prerelease":false,"published_at":"2023-11-12T11:17:17Z"},{"name":"v0.3.34","tag_name":"v0.3.34","prerelease":false,"published_at":"2023-11-12T11:21:59Z"}]'
action: "sort"
type: "nested-json"
key: "name"
modifier: "desc"
```
### Use output
```yaml
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Sort array of strings
id: sort_array
uses: yakubique/json-utils@v1.8
with:
input: '["1.0.0","1.1.0","1.2.0","1.2.1","1.3.0"]'
action: "sort"
modifier: "desc"
- name: Test 1
run: |
echo "Expecting [1.3.0,1.2.1,1.2.0,1.1.0,1.0.0]"
echo "${{ steps.sort_array.outputs.result }}"
```
## Pick
Creates an object composed of the picked object properties.
```yaml
- name: Pick "name"
uses: yakubique/json-utils@v1.8
with:
input: '[{"name":"v0.3.26","tag_name":"v0.3.26","prerelease":false,"published_at":"2023-08-07T09:43:28Z"},{"name":"v0.3.22","tag_name":"v0.3.22","prerelease":false,"published_at":"2023-11-12T10:58:00Z"},{"name":"v0.3.23","tag_name":"v0.3.23","prerelease":false,"published_at":"2023-11-12T10:59:27Z"},{"name":"v0.3.25","tag_name":"v0.3.25","prerelease":false,"published_at":"2023-11-12T11:01:20Z"},{"name":"v0.3.31","tag_name":"v0.3.31","prerelease":false,"published_at":"2023-11-12T11:17:17Z"},{"name":"v0.3.34","tag_name":"v0.3.34","prerelease":false,"published_at":"2023-11-12T11:21:59Z"}]'
action: "pick"
key: "name"
```
Works with multiple comma-separated keys
```yaml
- name: Pick "name"
uses: yakubique/json-utils@v1.8
with:
input: '[{"name":"v0.3.26","tag_name":"v0.3.26","prerelease":false,"published_at":"2023-08-07T09:43:28Z"},{"name":"v0.3.22","tag_name":"v0.3.22","prerelease":false,"published_at":"2023-11-12T10:58:00Z"},{"name":"v0.3.23","tag_name":"v0.3.23","prerelease":false,"published_at":"2023-11-12T10:59:27Z"},{"name":"v0.3.25","tag_name":"v0.3.25","prerelease":false,"published_at":"2023-11-12T11:01:20Z"},{"name":"v0.3.31","tag_name":"v0.3.31","prerelease":false,"published_at":"2023-11-12T11:17:17Z"},{"name":"v0.3.34","tag_name":"v0.3.34","prerelease":false,"published_at":"2023-11-12T11:21:59Z"}]'
action: "pick"
key: "name,prerelease"
# returns: [{name:v0.3.26,prerelease:false},{name:v0.3.22,prerelease:false},{name:v0.3.23,prerelease:false},{name:v0.3.25,prerelease:false},{name:v0.3.31,prerelease:false},{name:v0.3.34,prerelease:false}]
```
## Get
Return only value of picket object property.
```yaml
- name: Get "name"
id: get_name
uses: yakubique/json-utils@v1.8
with:
input: '[{"name":"v0.3.26","tag_name":"v0.3.26","prerelease":false,"published_at":"2023-08-07T09:43:28Z"},{"name":"v0.3.22","tag_name":"v0.3.22","prerelease":false,"published_at":"2023-11-12T10:58:00Z"},{"name":"v0.3.23","tag_name":"v0.3.23","prerelease":false,"published_at":"2023-11-12T10:59:27Z"},{"name":"v0.3.25","tag_name":"v0.3.25","prerelease":false,"published_at":"2023-11-12T11:01:20Z"},{"name":"v0.3.31","tag_name":"v0.3.31","prerelease":false,"published_at":"2023-11-12T11:17:17Z"},{"name":"v0.3.34","tag_name":"v0.3.34","prerelease":false,"published_at":"2023-11-12T11:21:59Z"}]'
action: "get"
key: "name"
# returns: [v0.3.26,v0.3.22,v0.3.23,v0.3.25,v0.3.31,v0.3.34]
```
## Concat
Concat `input` and `secondary` JSON arrays
```yaml
- name: Concat two arrays
uses: yakubique/json-utils@v1.8
with:
input: '["1.0.0","1.1.0",]'
secondary: '["1.2.0","1.2.1","1.3.0"]'
action: "concat"
# returns: ["1.0.0","1.1.0","1.2.0","1.2.1","1.3.0"]
```
## Chunk
Creates an array of elements split into groups the length of `modifier`. If array can't be split evenly, the final chunk
will be the remaining elements.
```yaml
- name: Chunk array
uses: yakubique/json-utils@v1.8
with:
input: '[1,2,3,4,5]'
action: "chunk"
modifier: 3
# returns: [[1,2,3],[4,5]]
```
## None
Sometimes it's OK to do nothing
```yaml
- name: Nothing to do
uses: yakubique/json-utils@v1.8
with:
input: '[1,2,3,4,5]'
action: "none"
# returns: [1,2,3,4,5]
```
## Inputs
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|-----------|--------|----------|---------------|-------------------------------------------------------------------------------------------------------|
| action | string | true | | What to do with input JSON
(available: "diff", "get", "pick", "sort", "concat", "chunk", "none") |
| input | string | true | | JSON string/Value from other action |
| key | string | false | | If `type="nested-json"` - which key should
be used |
| modifier | string | false | | Suitable modifier for performed action (ex: 'ASC'/'DESC' for 'sort') |
| secondary | string | false | | Secondary JSON string/Value from other action
(useful for some actions) |
| space | string | false | | `space` parameter to JSON.stringify as a
number |
| from_file | string | false | `"false"` | Load input from file (applied to secondary too) |
| to_file | string | false | `"false"` | Output to file |
| type | string | false | `"flat-json"` | Type of input data `["flat-json", "nested-json"]` (default: "flat-json") |
## Outputs
| OUTPUT | TYPE | DESCRIPTION |
|--------|--------|----------------|
| result | string | Processed JSON |
----
[](https://ko-fi.com/S6S1UZ9P7)