https://github.com/wolframresearch/pacletcicd

Continuous integration and deployment for Wolfram Language Paclets
https://github.com/wolframresearch/pacletcicd

Last synced: 9 months ago
JSON representation

Continuous integration and deployment for Wolfram Language Paclets

• Host: GitHub
• URL: https://github.com/wolframresearch/pacletcicd
• Owner: WolframResearch
• License: mit
• Created: 2022-01-22T19:11:14.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-12-19T20:37:03.000Z (about 1 year ago)
• Last Synced: 2025-03-28T17:49:34.120Z (10 months ago)
• Language: Mathematica
• Homepage:
• Size: 17.1 MB
• Stars: 12
• Watchers: 15
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          


********************************************************************************

[![Check Paclet](https://github.com/WolframResearch/PacletCICD/actions/workflows/check-paclet.yml/badge.svg)](https://github.com/WolframResearch/PacletCICD/actions/workflows/check-paclet.yml) [![Release Paclet](https://github.com/WolframResearch/PacletCICD/actions/workflows/release.yml/badge.svg)](https://github.com/WolframResearch/PacletCICD/actions/workflows/release.yml)

![Notebook Icon](.github/images/nb.svg) [View Notebooks](Notebooks.md)

# Installing PacletCICD

## From the [Wolfram Paclet Repository](https://resources.wolframcloud.com/PacletRepository/resources/Wolfram/PacletCICD)

Using Wolfram Language version 13.0 or later:

```Mathematica

PacletInstall[ResourceObject["Wolfram/PacletCICD"]]

```

## Using [GitHubInstall](https://resources.wolframcloud.com/FunctionRepository/resources/GitHubInstall/)

Using Wolfram Language version 12.0 or later:

```Mathematica

ResourceFunction["GitHubInstall"]["WolframResearch", "PacletCICD"]

```

## From Github

The PacletCICD release comes in the form of a `.paclet` file, which contains the entire package and its documentation. Download the latest release from the [GitHub repo's releases page](https://github.com/WolframResearch/PacletCICD/releases). To install, run the following command in the Wolfram Language:

```Mathematica

PacletInstall["/full/path/to/PacletCICD.paclet"]

```

This will permanently install the PacletCICD paclet. The Wolfram Language will always use the latest installed version of PacletCICD. Installed versions can be enumerated using the command:

```Mathematica

PacletFind["Wolfram/PacletCICD"]

```

And all versions can be uninstalled using the command:

```Mathematica

PacletUninstall["Wolfram/PacletCICD"]

```

# Features

Automatically check Paclets for potential issues in a GitHub CI/CD workflow:



Generate code annotations automatically whenever code is pushed to a branch:





## GitHub Actions

PacletCICD functions can be used indirectly via the following GitHub Marketplace actions:

* [build-paclet](https://github.com/marketplace/actions/build-paclet)

* [check-paclet](https://github.com/marketplace/actions/check-paclet)

These actions can also be automatically configured for your Paclet by using WorkflowExport:



# License

This project is licensed under the terms of the MIT license. See the LICENSE file in the root directory of this source tree for details.