Introducing GitPub

[StartAutomating]

Introducing GitPub

GitPub is a GitHub Action and PowerShell Module that helps Easily Automate Publishing from GitHub.

What does GitPub do?

GitPub gives you a flexible framework for converting content (primarily from GitHub) into published content.

For example, you can turn GitHub issues that match a certain label into Jeykll posts within a GitHub Page.

You might be reading output from GitPub that way right now. This post started as this GitHub issue.

Publishing this way makes for a more virtuous cycle when working with GitHub.

If you write high quality issues or release notes, you can share them with the world without breaking a sweat.

Using GitPub

You can use GitPub as a GitHub Action or as a PowerShell Module.

Using the GitPub action

You can easily use GitPub as a GitHub action.

In fact, GitPub uses itself to publish whenever issues change. See this simple workflow for reference.

Using the GitPub module

You can install GitPub from the PowerShell Gallery, or download a release from github:

Install-Module GitPub -Scope CurrentUser -Force
Import-Module GitPub -Force -PassThru

How GitPub Works

GitPub works using the simple concepts of Sources and Publishers.

GitPub Sources

A source is a function that provides content to post. GitPub comes with three sources:

Source	Function	Description
Gist	Get-GitPubGist	Turns gists into posts
Issue	Get-GitPubIssue	Turns issues into posts
Release	Get-GitPubRelease	Turns releases into posts

# List all sources
Get-GitPub |
    Select-Object -ExpandProperty Sources

GitPub Publishers

A publisher is a function that finalizes content and publishes it. GitPub comes with one publisher:

Source	Function	Description
Jeykll	Publish-GitPubJeykll	Publishes content to _posts directories

# List all publishers
Get-GitPub |
    Select-Object -ExpandProperty Publishers

Hopefully, as GitPub grows, these lists will grow with it.