Validate Outputs Action

• Inputs
• Outputs
• Examples
• Tags
• Support
• Contributing

Easily Validate Outputs from a GitHub Action or Workflow.

- name: 'Validate Outputs'
  uses: cssnr/validate-outputs-action@master
  with:
    outputs: ${{ toJSON(steps.test.outputs) }}
    data: |
      output1: must equal this
      output2: # must exist
      output3: ${{ steps.validate.outputs.output3 }}

Inputs

Input	Required Value for the Input	Input Description
outputs	${{ toJSON(steps.test.outputs) }}	Outputs JSON Data
data	Data to Verify in YAML format	Validation YAML Data

outputs

This should be your outputs JSON. If your step is named test set:

outputs: ${{ toJSON(steps.test.outputs) }}

data

This is the data to validate the outputs.

Keys are Output Keys. If you set a value it will be checked for equality, otherwise only for existence.

data: |
  output1: must equal this
  output2: # must exist
  output3: ${{ steps.validate.outputs.output3 }}

Outputs

Output	Description
errors	Errors JSON Object
keys	Checked JSON Keys
failed	Failed JSON Keys

- name: 'Validate Outputs'
  id: test
  uses: cssnr/validate-outputs-action@master
  with:
    outputs: ${{ toJSON(steps.test.outputs) }}
    data: |
      output1: must equal this

- name: 'Echo Outputs'
  run: |
    echo "errors: ${{ steps.test.outputs.errors }}"
    echo "keys: ${{ steps.test.outputs.keys }}"
    echo "failed: ${{ steps.test.outputs.failed }}"

Examples

💡 Click on an example heading to expand or collapse the example.

Examples Coming Soon...

For more examples, you can check out other projects using this action:
https://github.com/cssnr/validate-outputs-action/network/dependents

Tags

The following rolling tags are maintained.

Version Tag	Rolling	Bugs	Feat.	Name	Target	Example
	✅	✅	✅	Major	vN.x.x	vN
	✅	✅	❌	Minor	vN.N.x	vN.N
	❌	❌	❌	Micro	vN.N.N	vN.N.N

You can view the release notes for each version on the 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/validate-outputs-action/discussions/categories/q-a
• Request a Feature: https://github.com/cssnr/validate-outputs-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/validate-outputs-action/issues
• Chat with us on Discord: https://discord.gg/wXy6m2X8wY
• Provide General Feedback: https://cssnr.github.io/feedback/

For more information, see the CSSNR SUPPORT.md.

Contributing

If you would like to submit a PR, please review the CONTRIBUTING.md.

Please consider making a donation to support the development of this project and additional open source projects.

Additionally, you can support other GitHub Actions I have published:

• Stack Deploy Action
• Portainer Stack Deploy Action
• Docker Context Action
• Actions Up Action
• Zensical Action
• VirusTotal Action
• Mirror Repository Action
• Update Version Tags Action
• Docker Tags Action
• TOML Action
• Update JSON Value Action
• JSON Key Value Check Action
• Parse Issue Form Action
• Cloudflare Purge Cache Action
• Mozilla Addon Update Action
• Package Changelog Action
• NPM Outdated Check Action
• Label Creator Action
• Algolia Crawler Action
• Upload Release Action
• Check Build Action
• Web Request Action
• Get Commit Action

❔ Unpublished Actions

These actions are not published on the Marketplace, but may be useful.

• cssnr/create-files-action - Create various files from templates.
• cssnr/draft-release-action - Keep a draft release ready to publish.
• cssnr/env-json-action - Convert env file to json or vice versa.
• cssnr/push-artifacts-action - Sync files to a remote host with rsync.
• smashedr/update-release-notes-action - Update release notes.
• smashedr/combine-release-notes-action - Combine release notes.

---

📝 Template Actions

These are basic action templates that I use for creating new actions.

• javascript-action - JavaScript
• typescript-action - TypeScript
• py-test-action - Dockerfile Python
• test-action-uv - Dockerfile Python UV
• docker-test-action - Docker Image Python

Note: The docker-test-action builds, runs and pushes images to GitHub Container Registry.

---

For a full list of current projects visit: https://cssnr.github.io/