README.md

Test Paclet for the Wolfram Language Paclet Repository

The Test Paclet action is an interface to the TestPaclet function from Wolfram/PacletCICD and can be used to run your paclet test files within GitHub Actions.

Usage

A YAML file that uses this action can be automatically generated for your paclet using WorkflowExport:

PacletSymbol["Wolfram/PacletCICD", "WorkflowExport"]["path/to/paclet", "Test"]

Alternatively, using GitHub actions YAML syntax directly:

name: Test Paclet
on: [push]
jobs: 
  Test: 
    name: Test Paclet
    runs-on: ubuntu-latest
    container: 
      image: wolframresearch/wolframengine:latest
      options: --user root
    env: 
      WOLFRAMSCRIPT_ENTITLEMENTID: ${{ secrets.WOLFRAMSCRIPT_ENTITLEMENTID }}
    steps: 
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Test paclet
      uses: WolframResearch/test-paclet@v1

Parameters

Input	Default	Description
definition_notebook	"./ResourceDefinition.nb"	The relative path to the paclet's resource definition notebook
paclet_cicd_version	"latest"	The version of PacletCICD to use

Notes

For this action to work, your repository needs to have a license entitlement ID defined as a repository secret. See this tutorial for details.

See Also

• Action for building your paclet
• Action for checking your paclet for potential issues
• Action for submitting your paclet to the Wolfram Language Paclet Repository
• Continuous Integration and Deployment for Wolfram Language Paclets