Title: WP Github Commits
Author: Sudar Muthu
Published: <strong>February 12, 2013</strong>
Last modified: October 13, 2021

---

Search plugins

This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.

![](https://s.w.org/plugins/geopattern-icon/wp-github-commits.svg)

# WP Github Commits

 By [Sudar Muthu](https://profiles.wordpress.org/sudar/)

[Download](https://downloads.wordpress.org/plugin/wp-github-commits.0.6.zip)

 * [Details](https://pcd.wordpress.org/plugins/wp-github-commits/#description)
 * [Reviews](https://pcd.wordpress.org/plugins/wp-github-commits/#reviews)
 *  [Installation](https://pcd.wordpress.org/plugins/wp-github-commits/#installation)
 * [Development](https://pcd.wordpress.org/plugins/wp-github-commits/#developers)

 [Support](https://wordpress.org/support/plugin/wp-github-commits/)

## Description

Displays the latest commits of a github repo in the sidebar.

### Features

#### Sidebar Widget

The Plugin provides a sidebar widget which can be configured to display commits 
from a github repo in the sidebar. You can have multiple widgets with different 
repo configured for each one of them.

#### Template function

In addition to using the widget, you can also use the following template function
to display the commits of a github repo, anywhere in the theme

    ```
    get_github_commits($user, $repo, $count);
    ```

The following options can be passed in the `$options` array

 * `$user` (string) – Github user name.
 * `$repo` (string) – Github repo name.
 * `$count` (int) – default 5 – Number of recent commits to show

#### Custom field

You can also specify the repo for each post or page as a custom field. You can add
it under the “WP Github Commits Page fields” section in the Add/Edit post screen.

#### Caching

The Plugin caches the commits that is retrieved from Github for 5 hours.

#### Styling using CSS

The Plugin adds the following CSS classes. If you want to customize the look of 
the widget then can change it by adding custom styles to these CSS classes.

 * The outer `ul` tag has the class `github-commits`
 * Every `li` tag has the class `github-commit`

### Troubleshooting

If you get timeouts or the error “WP HTTP Error: name lookup timed out” then it 
means that your server is not timing out before github can respond.

You can use the code from [this gist](https://gist.github.com/sudar/4945588) to 
increase the timeout.

### Translation

The pot file is available with the Plugin. If you are willing to do translation 
for the Plugin, use the pot file to create the .po files for your language and let
me know. I will add it to the Plugin after giving credit to you.

### Development

The development of the Plugin happens over at [github](https://github.com/sudar/wp-github-commits).
If you want to contribute to the Plugin, fork the [project at github](https://github.com/sudar/wp-github-commits)
and send me a pull request.

If you are not familiar with either git or Github then refer to this [guide to see how fork and send pull request](http://sudarmuthu.com/blog/contributing-to-project-hosted-in-github).

If you are looking for ideas, then you can start with one of the following TODO 
items 🙂

### TODO

 * Shortcode support
 * Ability to hide author name
 * Make the output of widget content plugable

### Support

 * If you have found a bug/issue or have a feature request, then post them in [github issues](https://github.com/sudar/wp-github-commits/issues)
 * If you have a question about usage or need help to troubleshoot, then post in
   WordPress forums or leave a comment in [Plugins’s home page](http://sudarmuthu.com/wordpress/wp-github-commits)
 * If you like the Plugin, then kindly leave a review/feedback at [WordPress repo page](https://wordpress.org/extend/plugins/wp-github-commits/).
 * If anything else, then contact me in [twitter](http://twitter.com/sudarmuthu).

### Stay updated

I would be posting updates about this Plugin in my [blog](http://sudarmuthu.com/blog)
and in [Twitter](http://twitter.com/sudarmuthu). If you want to be informed when
new version of this Plugin is released, then you can either subscribe to this [blog’s RSS feed](http://sudarmuthu.com/feed)
or [follow me in Twitter](http://twitter.com/sudarmuthu).

Also checkout the [other WordPress Plugins](http://sudarmuthu.com/wordpress) that
I have created.

### Readme Generator

This Readme file was generated using [wp-readme](http://sudarmuthu.com/wordpress/wp-readme),
which generates readme files for WordPress Plugins.

## Installation

The simplest way to install the plugin is to use the built-in automatic plugin installer.
Go to plugins -> Add New and then enter the name of the plugin to automatically 
install it.

If for some reason the above method doesn’t work then you can download the plugin
as a zip file, extract it and then use your favorite FTP client and then upload 
the contents of the zip file to the wp-content/plugins/ directory of your WordPress
installation and then activate the Plugin from Plugins page.

## Reviews

There are no reviews for this plugin.

## Contributors & Developers

“WP Github Commits” is open source software. The following people have contributed
to this plugin.

Contributors

 *   [ Sudar Muthu ](https://profiles.wordpress.org/sudar/)

[Translate “WP Github Commits” into your language.](https://translate.wordpress.org/projects/wp-plugins/wp-github-commits)

### Interested in development?

[Browse the code](https://plugins.trac.wordpress.org/browser/wp-github-commits/),
check out the [SVN repository](https://plugins.svn.wordpress.org/wp-github-commits/),
or subscribe to the [development log](https://plugins.trac.wordpress.org/log/wp-github-commits/)
by [RSS](https://plugins.trac.wordpress.org/log/wp-github-commits/?limit=100&mode=stop_on_copy&format=rss).

## Changelog

#### v0.6 – (2016-11-13) – (Dev Time: 0.5 hour)

 * Tweak: Trimmed commit messages to 30 characters

#### v0.5 – (2013-04-24) – (Dev Time: 1 hour)

 * Tweak: Added documentation

#### v0.4 – (2013-02-16) – (Dev Time: 1 hour)

 * New: Generated pot file for translation
 * Tweak: Changed custom field names to make it compatible with other Plugins

#### v0.3 – (2013-02-14) – (Dev time: 1 hour)

 * Tweak: Use custom field for widget title only if it non-blank
 * Tweak: Formatted the date into a human readable format

#### v0.2 – (2013-02-13) – (Dev time: 1 hour)

 * New: Added option to take repo name from custom field in a post

#### v0.1 – (2013-02-11) – (Dev time: 3 hour)

 * Initial Release

## Meta

 *  Version **0.6**
 *  Last updated **4 years ago**
 *  Active installations **10+**
 *  WordPress version ** 3.5 or higher **
 *  Tested up to **5.8.13**
 *  Language
 * [English (US)](https://wordpress.org/plugins/wp-github-commits/)
 * Tags
 * [commits](https://pcd.wordpress.org/plugins/tags/commits/)[Github](https://pcd.wordpress.org/plugins/tags/github/)
   [widget](https://pcd.wordpress.org/plugins/tags/widget/)
 *  [Advanced View](https://pcd.wordpress.org/plugins/wp-github-commits/advanced/)

## Ratings

 4.5 out of 5 stars.

 *  [  1 5-star review     ](https://wordpress.org/support/plugin/wp-github-commits/reviews/?filter=5)
 *  [  1 4-star review     ](https://wordpress.org/support/plugin/wp-github-commits/reviews/?filter=4)
 *  [  0 3-star reviews     ](https://wordpress.org/support/plugin/wp-github-commits/reviews/?filter=3)
 *  [  0 2-star reviews     ](https://wordpress.org/support/plugin/wp-github-commits/reviews/?filter=2)
 *  [  0 1-star reviews     ](https://wordpress.org/support/plugin/wp-github-commits/reviews/?filter=1)

[Add my review](https://wordpress.org/support/plugin/wp-github-commits/reviews/#new-post)

[See all reviews](https://wordpress.org/support/plugin/wp-github-commits/reviews/)

## Contributors

 *   [ Sudar Muthu ](https://profiles.wordpress.org/sudar/)

## Support

Got something to say? Need help?

 [View support forum](https://wordpress.org/support/plugin/wp-github-commits/)