Github Tools for WordPress

A plugin that inserts dynamic updates for any GitHub repository.

Description

Use the custom GitHub Commit widget to display a list of the latest updates from a repository. Additionally, you can use shortcodes to add commit lists or embed any gist.
The plugin will cache the GitHub response for a certain time period (default: 1 day). You can change this value to half a day or 1 hour. To get more time frames you will need an additional plugin that extends the cron schedules.

Shortcodes

Embeds a gist in your post

  • id (required) The id of the gist you want to embed.

Displays the latest commits from your repository

  • repository (required) The name of the repository you wish to get.
  • count (optional) The number of commits to retrieve (order by date). Default: 5
  • title (optional) A title to display before the list (*h2*). Default: none

PHP functions

Feel free to use the Gihub helper class in your theme or plugin development.

<?php WP_Github_Tools_API::can_update(); ?>

<?php WP_Github_Tools_API::get_repos($user); ?>

<?php WP_Github_Tools_API::get_user($user); ?>

<?php WP_Github_Tools_API::get_commits($repo, $user); ?>

<?php WP_Github_Tools_API::get_gists($user); ?>

Contribute!

If you have suggestions for a new add-on, feel free to email me at ioo.vilmos@gmail.com. Alternatively, you can fork the plugin from Gihub

Or follow updates on Twitter!

Installation

  1. Download the plugin files and upload them to your /wp-content/plugins/ directory
  2. Activate the plugin through the ‘Plugins’ menu in WordPress
  3. Set your GitHub username using the ‘GitHub Tools’ page under the Tools menu
  4. Ready to go!

Changelog

1.0 20 February 2013

  • Added custom widget to display repository commits.
  • Implemented custom shortcode to display repository commits.
  • Implemented custom shortcode to embed gists.
  • Customizable cache system.
  • Live validation of GitHub usernames.