smashedr/js-test-action

JavaScript Test Action

JavaScript Test Action

• Inputs
  • Permissions
• Outputs
• Examples
• Tags
• Support
• Contributing
• Development

JavaScript Test Action Template.

This action creates or updates the provided tag to the sha has that triggered the workflow.

This includes inputs, outputs, job summary, and automatic token authentication.

• JavaScript: https://github.com/smashedr/js-test-action
• TypeScript: https://github.com/smashedr/ts-test-action
• Docker: https://github.com/smashedr/docker-test-action
• Python: https://github.com/smashedr/py-test-action

Inputs

Input	Req.	Default Value	Input Description
tag	-	test	Tag to Create or Update
summary	-	true	Add Summary to Job
token	-	github.token	Only for PAT 1

👀 View Example Job Summary

---

Updated: test ➡️ 6470ef53102d5229672433f1adb6afa42e7b64d9

Inputs

Input	Value
tag	test
summary	true

---

With no inputs this will create/update the tag test.

- name: 'JavaScript Test Action'
  uses: smashedr/js-test-action@master

With all inputs.

- name: 'JavaScript Test Action'
  uses: smashedr/js-test-action@master
  with:
    tag: test
    summary: true
    token: ${{ secrets.PAT }} # only include this if you need to use a PAT

Permissions

This action requires the following permissions:

permissions:
  contents: write

Permissions documentation for Workflows and Actions.

Outputs

Output	Description
sha	Tag Hash

- name: 'JavaScript Test Action'
  id: test
  uses: smashedr/js-test-action@master

- name: 'Echo Output'
  run: |
    echo "sha: '${{ steps.test.outputs.sha }}'"

Examples

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

name: 'Test'

on:
  workflow_dispatch:
  push:

jobs:
  test:
    name: 'Test'
    runs-on: ubuntu-latest
    timeout-minutes: 5
    permissions:
      contents: write

    steps:
      - name: 'Checkout'
        uses: actions/checkout@v4

      - name: 'JavaScript Test Action'
        id: test
        uses: smashedr/js-test-action@master

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

For more examples, you can check out other projects using this action:
https://github.com/smashedr/js-test-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/smashedr/js-test-action/discussions/categories/q-a
• Request a Feature: https://github.com/smashedr/js-test-action/discussions/categories/feature-requests

If you are experiencing an issue/bug or getting unexpected results, you can:

• Report an Issue: https://github.com/smashedr/js-test-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
• VirusTotal Action
• Mirror Repository Action
• Update Version Tags Action
• Docker Tags 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.

• js-test-action - JavaScript
• py-test-action - Python
• ts-test-action - TypeScript
• docker-test-action - Docker Image

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/

Development

Development instructions have been moved to the local CONTRIBUTING.md. Additional notes are being added to TEMPLATE.md.

Footnotes

1. The ${{ github.token }} / {{ secrets.GITHUB_TOKEN }} is automatically passed, there is no need to manually pass these! This is only available to allow users to pass a different token they have created and defined in their secrets. ↩