https://github.com/cssnr/update-json-value-action
Update JSON Value Action
https://github.com/cssnr/update-json-value-action
actions
Last synced: 5 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 (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-03-20T22:43:58.000Z (4 months ago)
- Last Synced: 2025-03-20T23:29:58.747Z (4 months ago)
- Topics: actions
- Language: JavaScript
- Homepage: https://cssnr.github.io
- Size: 391 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/cssnr/update-json-value-action/tags)
[](https://github.com/cssnr/update-json-value-action/tags)
[](https://github.com/cssnr/update-json-value-action/releases/latest)
[](https://github.com/cssnr/update-json-value-action/blob/master/src/index.js)
[](https://github.com/cssnr/update-json-value-action/actions/workflows/release.yaml)
[](https://github.com/cssnr/update-json-value-action/actions/workflows/test.yaml)
[](https://github.com/cssnr/update-json-value-action/actions/workflows/lint.yaml)
[](https://sonarcloud.io/summary/new_code?id=cssnr_update-json-value-action)
[](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
- [Inputs](#Inputs)
- [Outputs](#Outputs)
- [Examples](#Examples)
- [Tags](#Tags)
- [Support](#Support)
- [Contributing](#Contributing)
Update JSON file Key Values for Building or 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.
> [!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 | Req. | Default Value | Input Description |
| :-------- | :--: | :----------------- | :--------------------- |
| file | - | `manifest.json` | JSON File Path |
| keys | - | `version` | JSON Keys to Update \* |
| values | - | `$GITHUB_REF_NAME` | Values to Update \* |
| write | - | `true` | Write Updates to file |
| seperator | - | `.` | Nested Key Seperator |
| summary | - | `true` | Add Summary to Job \* |
**keys/values:** A newline delimited `|` list of keys/values to update, one per line.
See [Examples](#Examples) for more details.
**summary:** Write a Summary for the job. To disable this set to `false`.
To view a workflow run, click on a recent [Test](https://github.com/cssnr/update-json-value-action/actions/workflows/test.yaml) job _(requires login)_.
👀 View Example Summary
---
💾 ✔️ `package.json`
Keys/ValuesKeyValuenametestscripts.linttest
Results
```json
{
"name": "test",
"scripts": {
"build": "ncc build src/index.js",
"build:watch": "npm run build -- --watch",
"lint": "test"
},
"dependencies": {
"@actions/core": "^1.11.1"
},
"devDependencies": {
"@eslint/js": "^9.20.0",
"@vercel/ncc": "^0.38.3",
"eslint": "^9.20.1",
"eslint-config-prettier": "^10.0.1",
"eslint-plugin-prettier": "^5.2.3",
"prettier": "^3.5.1"
}
}
```
InputsInputValuefilepackage.jsonkeysname,scripts.lintvaluestest,testwritetrueseperator.
---
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 | 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
💡 _Click on an example heading to expand or collapse the example._
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 }}
```
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 }}"
```
For more examples, you can check out other projects using this action:
https://github.com/cssnr/update-json-value-action/network/dependents
## Tags
The following rolling [tags](https://github.com/cssnr/update-json-value-action/tags) are maintained.
| Version Tag | Rolling | Bugs | Feat. | Name | Target | Example |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-----: | :--: | :---: | :-------: | :------: | :------- |
| [](https://github.com/cssnr/update-json-value-action/releases/latest) | ✅ | ✅ | ✅ | **Major** | `vN.x.x` | `vN` |
| [](https://github.com/cssnr/update-json-value-action/releases/latest) | ✅ | ✅ | ❌ | **Minor** | `vN.N.x` | `vN.N` |
| [](https://github.com/cssnr/update-json-value-action/releases/latest) | ❌ | ❌ | ❌ | **Micro** | `vN.N.N` | `vN.N.N` |
You can view the release notes for each version on the [releases](https://github.com/cssnr/update-json-value-action/releases) page.
The **Major** tag is recommended. It is the most up-to-date and always backwards compatible.
Breaking changes would result in a **Major** version bump. At a minimum you should use a **Minor** tag.
# 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)
For more information, see the CSSNR [SUPPORT.md](https://github.com/cssnr/.github/blob/master/.github/SUPPORT.md#support).
# Contributing
Currently, the best way to contribute to this project is to star this project on GitHub.
For more information, see the CSSNR [CONTRIBUTING.md](https://github.com/cssnr/.github/blob/master/.github/CONTRIBUTING.md#contributing).
Additionally, you can support other GitHub Actions I have published:
- [Stack Deploy Action](https://github.com/cssnr/stack-deploy-action?tab=readme-ov-file#readme)
- [Portainer Stack Deploy](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#readme)
- [VirusTotal Action](https://github.com/cssnr/virustotal-action?tab=readme-ov-file#readme)
- [Mirror Repository Action](https://github.com/cssnr/mirror-repository-action?tab=readme-ov-file#readme)
- [Update Version Tags Action](https://github.com/cssnr/update-version-tags-action?tab=readme-ov-file#readme)
- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action?tab=readme-ov-file#readme)
- [Parse Issue Form Action](https://github.com/cssnr/parse-issue-form-action?tab=readme-ov-file#readme)
- [Cloudflare Purge Cache Action](https://github.com/cssnr/cloudflare-purge-cache-action?tab=readme-ov-file#readme)
- [Mozilla Addon Update Action](https://github.com/cssnr/mozilla-addon-update-action?tab=readme-ov-file#readme)
- [Docker Tags Action](https://github.com/cssnr/docker-tags-action?tab=readme-ov-file#readme)
- [Package Changelog Action](https://github.com/cssnr/package-changelog-action?tab=readme-ov-file#readme)
- [NPM Outdated Check Action](https://github.com/cssnr/npm-outdated-action?tab=readme-ov-file#readme)
For a full list of current projects to support visit: [https://cssnr.github.io/](https://cssnr.github.io/)