GitHub Workflows¶
PSReddit uses GitHub Actions to automate testing, documentation deployment, and module publishing. Below are the workflows and their triggers:
Testing¶
- PSReddit - Test (
.github/workflows/psreddit-test.yml): runs the fullInvoke-Build(formatting, PSScriptAnalyzer, unit tests with a 90% coverage floor, help, build, built-module export check, integration tests) on Ubuntu, Windows and macOS for every pull request and push tomainthat touches code. - Lint (
.github/workflows/lint.yml): runs super-linter, including PSScriptAnalyzer with.github/linters/.powershell-psscriptanalyzer.psd1.
Documentation Deployment¶
- Docs (
.github/workflows/docs.yml): builds the Zensical site on pull requests that touchdocs/, and publishes it to GitHub Pages on push tomain.
Module Publishing¶
- PSReddit - Publish Module (
.github/workflows/psreddit-publish-module.yml): runs on new release publishes to push the module to the PowerShell Gallery.