GitHub Action
Check Paclet
v1.11.0
Latest version
Check Paclet for the Wolfram Language Paclet Repository
The Check Paclet action is an interface to the
CheckPaclet
function from
Wolfram/PacletCICD
and can be used to check your Wolfram Language paclet for potential issues within GitHub Actions.
This is roughly equivalent to using the Check > All menu item from the resource definition notebook within
Wolfram Desktop or Mathematica.
A YAML file that uses this action can be automatically generated for your paclet using
WorkflowExport
:
PacletSymbol["Wolfram/PacletCICD", "WorkflowExport"]["path/to/paclet", "Check"]
Alternatively, using GitHub actions YAML syntax directly:
name: Check Paclet
on: [push]
jobs:
Check:
name: Check 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: Check paclet
uses: WolframResearch/check-paclet@v1
Input | Default | Description |
---|---|---|
target |
"Submit" |
The named configuration to use for error checking. Some possible values are "Build" , "Check" , "Deploy" , and "Submit" . |
definition_notebook |
"./ResourceDefinition.nb" |
The relative path to the paclet's resource definition notebook |
paclet_cicd_version |
"latest" |
The version of PacletCICD to use |
For this action to work, your repository needs to have a license entitlement ID defined as a repository secret. See this tutorial for details.