Wolfram Language Paclet Repository

Community-contributed installable additions to the Wolfram Language

Primary Navigation

    • Cloud & Deployment
    • Core Language & Structure
    • Data Manipulation & Analysis
    • Engineering Data & Computation
    • External Interfaces & Connections
    • Financial Data & Computation
    • Geographic Data & Computation
    • Geometry
    • Graphs & Networks
    • Higher Mathematical Computation
    • Images
    • Knowledge Representation & Natural Language
    • Machine Learning
    • Notebook Documents & Presentation
    • Scientific and Medical Data & Computation
    • Social, Cultural & Linguistic Data
    • Strings & Text
    • Symbolic & Numeric Computation
    • System Operation & Setup
    • Time-Related Computation
    • User Interface Construction
    • Visualization & Graphics
    • Random Paclet
    • Alphabetical List
  • Using Paclets
    • Get Started
    • Download Definition Notebook
  • Learn More about Wolfram Language

PacletCICD

Tutorials

  • GitHub Actions Quick Start

Guides

  • Continuous Integration and Deployment
  • Custom CI/CD Workflows
  • Workflows

Tech Notes

  • License Entitlements and Repository Secrets

Symbols

  • BuildPaclet
  • CheckPaclet
  • CreatePublisherToken
  • ExampleDirectory
  • GitHubSecret
  • PublisherTokenObject
  • SubmitPaclet
  • WorkflowEvaluate
  • WorkflowExport
  • WorkflowJob
  • WorkflowJobQ
  • Workflow
  • WorkflowQ
  • WorkflowStep
  • WorkflowStepQ
  • WorkflowValue

Other

  • ResourcePublisherToken
  • WolframScriptEntitlementID
Wolfram`PacletCICD`
CheckPaclet
​
CheckPaclet
[]
checks the paclet located in the current
Directory
[]
.
​
​
CheckPaclet
[
File
["path"]]
uses the given definition notebook or directory specified by
"path"
.
​
Details and Options

Examples  
(7)
Basic Examples  
(5)
Load the PacletCICD package:
In[1]:=
Needs["Wolfram`PacletCICD`"];
​
Get an example paclet directory:
In[1]:=
dir=
ExampleDirectory
["FewIssues"]
Out[1]=
File
C:/Users/rhennigan/AppData/Roaming/Mathematica/ApplicationData/Wolfram/PacletCICD/Examples/FewIssues

Check the paclet for issues:
In[2]:=
CheckPaclet
[dir]
The description should usually not end with punctuation
(DescriptionEndsInPunctuation:120063846)
Out[2]=
​
Check a paclet with several issues:
In[1]:=
CheckPaclet

ExampleDirectory
["MoreIssues"]
CodeInspect found 1 fatal error
(CodeInspectionIssues:57873694)
CodeInspect found 1 error
(CodeInspectionIssues:76478523)
CodeInspect found 1 error and 1 warning
(CodeInspectionIssues:351143504)
The documentation metadata has an incorrect paclet name (SamplePublisher/WrongPacletName)
(DocumentationWrongPacletName:268995717)
The paclet creator and the resource creator are expected to match
(PacletCreatorMismatch:312969925)
Example captions should usually end in a colon when appearing before input
(ExampleTextLastCharacter:319073343)
Inputs should be separated so they each generate at most a single output
(MultipleOutputs:55333842)
Related links should usually be given as a labeled hyperlink instead of a raw URL
(StringLink:437199519)
Scraping failed due to the specified failure conditions.
CheckPaclet
::errors
:Errors encountered while checking paclet.
Out[1]=
Failure

Message:
Errors encountered while checking paclet.
Tag:
CheckPaclet::errors

Get the
Dataset
of issues:
In[2]:=
%["Result"]
Out[2]=
​
Suppress some inspections:
In[1]:=
CheckPaclet

ExampleDirectory
["MoreIssues"],"DisabledHints"{Inherited,"CodeInspectionIssues"}
The documentation metadata has an incorrect paclet name (SamplePublisher/WrongPacletName)
(DocumentationWrongPacletName:268995717)
The paclet creator and the resource creator are expected to match
(PacletCreatorMismatch:312969925)
Example captions should usually end in a colon when appearing before input
(ExampleTextLastCharacter:319073343)
Inputs should be separated so they each generate at most a single output
(MultipleOutputs:55333842)
Related links should usually be given as a labeled hyperlink instead of a raw URL
(StringLink:437199519)
Out[1]=
​
Specify the conditions that will trigger an inspection failure:
In[1]:=
CheckPaclet

ExampleDirectory
["MoreIssues"],​​"DisabledHints"{Inherited,"CodeInspectionIssues"},"FailureCondition"{"Warning","Error"}
The documentation metadata has an incorrect paclet name (SamplePublisher/WrongPacletName)
(DocumentationWrongPacletName:268995717)
The paclet creator and the resource creator are expected to match
(PacletCreatorMismatch:312969925)
Example captions should usually end in a colon when appearing before input
(ExampleTextLastCharacter:319073343)
Inputs should be separated so they each generate at most a single output
(MultipleOutputs:55333842)
Related links should usually be given as a labeled hyperlink instead of a raw URL
(StringLink:437199519)
Scraping failed due to the specified failure conditions.
CheckPaclet
::errors
:Errors encountered while checking paclet.
Out[1]=
Failure

Message:
Errors encountered while checking paclet.
Tag:
CheckPaclet::errors

In[2]:=
CheckPaclet

ExampleDirectory
["MoreIssues"],​​"DisabledHints"{Inherited,"CodeInspectionIssues"},"FailureCondition"{{"Warning",MaxItems3},"Error"}
The documentation metadata has an incorrect paclet name (SamplePublisher/WrongPacletName)
(DocumentationWrongPacletName:268995717)
The paclet creator and the resource creator are expected to match
(PacletCreatorMismatch:312969925)
Example captions should usually end in a colon when appearing before input
(ExampleTextLastCharacter:319073343)
Inputs should be separated so they each generate at most a single output
(MultipleOutputs:55333842)
Related links should usually be given as a labeled hyperlink instead of a raw URL
(StringLink:437199519)
Out[2]=
Applications  
(2)

SeeAlso
BuildPaclet
 
▪
WorkflowExport
RelatedGuides
▪
Continuous Integration and Deployment
▪
Custom CI/CD Workflows
""

Powered by the Wolfram Cloud More about Wolfram Technology

© 2022 Wolfram Research, Inc. All rights reserved. Terms of Use Privacy Contact Us