https://github.com/startautomating/gitpub

Easily Automate Publishing from GitHub
https://github.com/startautomating/gitpub

github jekyll jekyll-blog microblogging powershell

Last synced: 8 days ago
JSON representation

Easily Automate Publishing from GitHub

• Host: GitHub
• URL: https://github.com/startautomating/gitpub
• Owner: StartAutomating
• License: mit
• Created: 2022-10-10T01:08:34.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2022-12-12T10:15:24.000Z (almost 2 years ago)
• Last Synced: 2024-10-10T22:21:04.525Z (28 days ago)
• Topics: github, jekyll, jekyll-blog, microblogging, powershell
• Language: PowerShell
• Homepage: https://gitpub.start-automating.com
• Size: 142 KB
• Stars: 9
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        






# 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](https://github.com/StartAutomating/GitPub/issues/1).

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 module

You can install GitPub from the PowerShell Gallery, or download a release from [github](https://github.com/StartAutomating/GitPub):

~~~PowerShell

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

Sources can provide content to publish.

GitPub is written so that you can write your own sources easily.

Any function that adds `[Reflection.AssemblyMetadata('GitPub.Source','true')]` will be considered a source.

GitPub ships with the following sources:

|Name                                      |

|------------------------------------------|

|[Get-GitPubGist](Get-GitPubGist.ps1)      |

|[Get-GitPubIssue](Get-GitPubIssue.ps1)    |

|[Get-GitPubRelease](Get-GitPubRelease.ps1)|

### GitPub Publishers

Any function that adds `[Reflection.AssemblyMetadata('GitPub.Publisher','true')]` will be considered a publisher.

|Name                                            |

|------------------------------------------------|

|[Publish-GitPubJekyll](Publish-GitPubJekyll.ps1)|