Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cssnr/update-json-value-action
Update JSON Value Action
https://github.com/cssnr/update-json-value-action
actions
Last synced: 2 days ago
JSON representation
Update JSON Value Action
- Host: GitHub
- URL: https://github.com/cssnr/update-json-value-action
- Owner: cssnr
- License: gpl-3.0
- Created: 2024-06-07T21:04:00.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-09-26T08:35:55.000Z (4 months ago)
- Last Synced: 2024-11-10T15:06:54.869Z (2 months ago)
- Topics: actions
- Language: JavaScript
- Homepage: https://cssnr.github.io
- Size: 308 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://github.com/cssnr/update-json-value-action/actions/workflows/tags.yaml)
[](https://github.com/cssnr/update-json-value-action/actions/workflows/test.yaml)
[](https://sonarcloud.io/summary/new_code?id=cssnr_update-json-value-action)
[](https://github.com/cssnr/update-json-value-action/releases/latest)
[](https://github.com/cssnr/update-json-value-action/graphs/commit-activity)
[](https://codeberg.org/cssnr/update-json-value-action)
[](https://github.com/cssnr/update-json-value-action)
[](https://cssnr.github.io/)
[](https://discord.gg/wXy6m2X8wY)
# Update JSON Value Action
Update JSON file Value(s) for Publishing.
Zero configuration action to update a `manifest.json` file `version` value to a release tag.
Allows setting multiple key/value pairs and setting nested keys. Currently only supports string values.
- [Inputs](#Inputs)
- [Outputs](#Outputs)
- [Examples](#Examples)
- [Support](#Support)
- [Contributing](#Contributing)
> [!NOTE]
> Please submit
> a [Feature Request](https://github.com/cssnr/update-json-value-action/discussions/categories/feature-requests)
> for new features or [Open an Issue](https://github.com/cssnr/update-json-value-action/issues) if you find any bugs.
## Inputs
| input | required | default | description |
| --------- | -------- | ------------------ | --------------------------------- |
| file | No | `manifest.json` | JSON File Path |
| keys | No | `version` | JSON Keys to Update, One per Line |
| values | No | `$GITHUB_REF_NAME` | Values to Update, One per Line |
| write | No | `true` | Write Updates to `file` |
| seperator | No | `.` | Nested Key Seperator |
If no options are passed, it will update the `manifest.json` file's key `version` to the value of `GITHUB_REF_NAME`.
For multiple `keys` and `values` use new lines with a yaml `|`.
```yaml
- name: 'Update JSON'
uses: cssnr/update-json-value-action@v1
```
## Outputs
| output | description |
| ------ | ------------------- |
| result | Updated JSON String |
```yaml
- name: 'Update JSON'
id: json
uses: cssnr/update-json-value-action@v1
- name: 'Echo Result'
run: echo '${{ steps.json.outputs.result }}'
```
## Examples
Same as above but manually setting values and only running on `release` events.
```yaml
- name: 'Update JSON'
uses: cssnr/update-json-value-action@v1
if: ${{ github.event_name == 'release' }}
with:
file: manifest.json
keys: version
values: ${{ github.ref_name }}
```
Same as above but also setting an additional key value pair.
```yaml
- name: 'Update JSON'
uses: cssnr/update-json-value-action@v1
if: ${{ github.event_name == 'release' }}
with:
file: manifest.json
keys: |
version
version_name
values: |
${{ github.ref_name }}
"Release ${{ github.ref_name }}"
```
Set a nested key and use file from different directory.
```yaml
- name: 'Update JSON'
uses: cssnr/update-json-value-action@v1
if: ${{ github.event_name == 'release' }}
with:
file: src/manifest.json
keys: |
meta.version
values: |
"Release ${{ github.ref_name }}"
```
# Support
For general help or to request a feature, see:
- Q&A Discussion: https://github.com/cssnr/update-json-value-action/discussions/categories/q-a
- Request a Feature: https://github.com/cssnr/update-json-value-action/discussions/categories/feature-requests
If you are experiencing an issue/bug or getting unexpected results, you can:
- Report an Issue: https://github.com/cssnr/update-json-value-action/issues
- Chat with us on Discord: https://discord.gg/wXy6m2X8wY
- Provide General
Feedback: [https://cssnr.github.io/feedback/](https://cssnr.github.io/feedback/?app=Update%20JSON%20Value)
# Contributing
Currently, the best way to contribute to this project is to star this project on GitHub.
Additionally, you can support other GitHub Actions I have published:
- [VirusTotal Action](https://github.com/cssnr/virustotal-action)
- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action)
- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action)
- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action)
- [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action)
- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action)
- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action)
For a full list of current projects to support visit: [https://cssnr.github.io/](https://cssnr.github.io/)