https://github.com/mapkyca/KnownGithubProjects

A content type to post your github projects, contains a webhook endpoint for updates!
https://github.com/mapkyca/KnownGithubProjects

Last synced: 3 months ago
JSON representation

A content type to post your github projects, contains a webhook endpoint for updates!

• Host: GitHub
• URL: https://github.com/mapkyca/KnownGithubProjects
• Owner: mapkyca
• Created: 2015-01-12T19:23:44.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-12T19:24:00.000Z (almost 10 years ago)
• Last Synced: 2024-07-27T05:33:06.400Z (4 months ago)
• Language: PHP
• Size: 102 KB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Github Projects for Known

=========================

This plugin provides an new content type - a Github Project, for you to list github projects that you create.

It allows you to provide some description about your project, and also provides the owner with a webhook endpoint, which can be used in the project's github notification settings, to fire webhooks your way.

You can use these hooks to update your github project page entry. 

Installation

------------

* Drop the GithubProject folder into the IndoPlugins folder of your Known installation.

* Log into known and click on Administration.

* Click "install" on the plugins page

Using the webhook

-----------------

As the owner of a Github project entry, you will be given a special url. Use this URL in Github's webhook settings (found in your project's settings page).

Once set up, github will ping this endpoint when something happens to your project. 

When a webhook is received and validated, this plugin will fire an event ```webhook/github/[ACTION]``` where [ACTION] is the webhook action being triggered (see https://developer.github.com/webhooks/) for details.

This plugin will also, by default, update the entry's updated timestamp, so if you sort your projects by updated time it'll show the most recently updated ones first. Handy for project lists.

See

---

 * Author: Marcus Povey  

 * Github actions documentation