https://github.com/cssnr/json-key-value-check-action
Check that JSON Key's Values Match Provided Values
https://github.com/cssnr/json-key-value-check-action
actions
Last synced: 15 days ago
JSON representation
Check that JSON Key's Values Match Provided Values
- Host: GitHub
- URL: https://github.com/cssnr/json-key-value-check-action
- Owner: cssnr
- License: gpl-3.0
- Created: 2024-07-25T18:51:55.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2025-02-11T06:33:24.000Z (over 1 year ago)
- Last Synced: 2025-02-11T07:28:24.010Z (over 1 year ago)
- Topics: actions
- Language: TypeScript
- Homepage: https://cssnr.github.io
- Size: 304 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/cssnr/json-key-value-check-action/tags)
[](https://github.com/cssnr/json-key-value-check-action/releases)
[](https://github.com/cssnr/json-key-value-check-action/releases/latest)
[](https://github.com/cssnr/json-key-value-check-action/blob/master/src/index.ts)
[](https://github.com/cssnr/json-key-value-check-action/blob/master/action.yml)
[](https://github.com/cssnr/json-key-value-check-action/actions/workflows/release.yaml)
[](https://github.com/cssnr/json-key-value-check-action/actions/workflows/test.yaml)
[](https://github.com/cssnr/json-key-value-check-action/actions/workflows/lint.yaml)
[](https://sonarcloud.io/summary/new_code?id=cssnr_json-key-value-check-action)
[](https://github.com/cssnr/json-key-value-check-action/pulse)
[](https://codeberg.org/cssnr/json-key-value-check-action)
[](https://github.com/cssnr/json-key-value-check-action/graphs/contributors)
[](https://github.com/cssnr/json-key-value-check-action?tab=readme-ov-file#readme)
[](https://github.com/cssnr/json-key-value-check-action)
[](https://github.com/cssnr/json-key-value-check-action/discussions)
[](https://github.com/cssnr/json-key-value-check-action/forks)
[](https://github.com/cssnr/json-key-value-check-action/stargazers)
[](https://cssnr.github.io/)
[](https://discord.gg/wXy6m2X8wY)
[](https://ko-fi.com/cssnr)
# JSON Key Value Check Action
- [Inputs](#Inputs)
- [Examples](#Examples)
- [Tags](#Tags)
- [Support](#Support)
- [Contributing](#Contributing)
Check that JSON Key's Values Match Provided Values.
> [!NOTE]
> Please submit a [Feature Request](https://github.com/cssnr/json-key-value-check-action/discussions/categories/feature-requests)
> for new features or [Open an Issue](https://github.com/cssnr/json-key-value-check-action/issues) if you find any bugs.
## Inputs
| Input | Default | Description of the Input |
| :-------- | :--------- | :-------------------------------------- |
| file | _Required_ | JSON File Path to Validate |
| keys | _Required_ | Keys to Check, One per Line |
| values | _Required_ | Values to Verify, One per Line |
| seperator | `.` | Nested Key Seperator |
For multiple `keys` and `values` use new lines with a yaml `|`.
## Examples
```yaml
- name: 'Verify JSON'
uses: cssnr/json-key-value-check-action@v2
with:
file: manifest.json
keys: version
values: ${{ github.ref_name }}
```
Same as above but also setting an additional key value pair.
```yaml
- name: 'Verify JSON'
uses: cssnr/json-key-value-check-action@v2
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: 'Verify JSON'
uses: cssnr/json-key-value-check-action@v2
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/json-key-value-check-action/network/dependents
## Tags
The following rolling [tags](https://github.com/cssnr/json-key-value-check-action/tags) are maintained.
| Version Tag | Rolling | Bugs | Feat. | Name | Target | Example |
| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :-----: | :--: | :---: | :-------: | :------: | :------- |
| [](https://github.com/cssnr/json-key-value-check-action/releases) | ✅ | ✅ | ✅ | **Major** | `vN.x.x` | `vN` |
| [](https://github.com/cssnr/json-key-value-check-action/releases) | ✅ | ✅ | ❌ | **Minor** | `vN.N.x` | `vN.N` |
| [](https://github.com/cssnr/json-key-value-check-action/releases) | ❌ | ❌ | ❌ | **Micro** | `vN.N.N` | `vN.N.N` |
You can view the release notes for each version on the [releases](https://github.com/cssnr/json-key-value-check-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/json-key-value-check-action/discussions/categories/q-a
- Request a Feature: https://github.com/cssnr/json-key-value-check-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/json-key-value-check-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=Stack%20Deploy%20Action)
For more information, see the CSSNR [SUPPORT.md](https://github.com/cssnr/.github/blob/master/.github/SUPPORT.md#support).
# Contributing
If you would like to submit a PR, please review the [CONTRIBUTING.md](#contributing-ov-file).
Please consider making a donation to support the development of this project
and [additional](https://cssnr.com/) open source projects.
[](https://ko-fi.com/cssnr)
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 Action](https://github.com/cssnr/portainer-stack-deploy-action?tab=readme-ov-file#readme)
- [Docker Context Action](https://github.com/cssnr/docker-context-action?tab=readme-ov-file#readme)
- [Actions Up Action](https://github.com/cssnr/actions-up-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)
- [Docker Tags Action](https://github.com/cssnr/docker-tags-action?tab=readme-ov-file#readme)
- [Update JSON Value Action](https://github.com/cssnr/update-json-value-action?tab=readme-ov-file#readme)
- [JSON Key Value Check Action](https://github.com/cssnr/json-key-value-check-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)
- [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)
- [Label Creator Action](https://github.com/cssnr/label-creator-action?tab=readme-ov-file#readme)
- [Algolia Crawler Action](https://github.com/cssnr/algolia-crawler-action?tab=readme-ov-file#readme)
- [Upload Release Action](https://github.com/cssnr/upload-release-action?tab=readme-ov-file#readme)
- [Check Build Action](https://github.com/cssnr/check-build-action?tab=readme-ov-file#readme)
- [Web Request Action](https://github.com/cssnr/web-request-action?tab=readme-ov-file#readme)
- [Get Commit Action](https://github.com/cssnr/get-commit-action?tab=readme-ov-file#readme)
❔ Unpublished Actions
These actions are not published on the Marketplace, but may be useful.
- [cssnr/create-files-action](https://github.com/cssnr/create-files-action?tab=readme-ov-file#readme) - Create various files from templates.
- [cssnr/draft-release-action](https://github.com/cssnr/draft-release-action?tab=readme-ov-file#readme) - Keep a draft release ready to publish.
- [cssnr/env-json-action](https://github.com/cssnr/env-json-action?tab=readme-ov-file#readme) - Convert env file to json or vice versa.
- [cssnr/push-artifacts-action](https://github.com/cssnr/push-artifacts-action?tab=readme-ov-file#readme) - Sync files to a remote host with rsync.
- [smashedr/update-release-notes-action](https://github.com/smashedr/update-release-notes-action?tab=readme-ov-file#readme) - Update release notes.
- [smashedr/combine-release-notes-action](https://github.com/smashedr/combine-release-notes-action?tab=readme-ov-file#readme) - Combine release notes.
---
📝 Template Actions
These are basic action templates that I use for creating new actions.
- [js-test-action](https://github.com/smashedr/js-test-action?tab=readme-ov-file#readme) - JavaScript
- [ts-test-action](https://github.com/smashedr/ts-test-action?tab=readme-ov-file#readme) - TypeScript
- [py-test-action](https://github.com/smashedr/py-test-action?tab=readme-ov-file#readme) - Python (Dockerfile)
- [docker-test-action](https://github.com/smashedr/docker-test-action?tab=readme-ov-file#readme) - Docker (Image)
Note: The `docker-test-action` builds, runs and pushes images to [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry).
---
For a full list of current projects visit: [https://cssnr.github.io/](https://cssnr.github.io/)