About this plugin
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 to increase the timeout.
Translation
The pot file is available with the Plugin. 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. If you want to contribute to the Plugin, fork the project at github 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.
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
- 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
- If you like the Plugin, then kindly leave a review/feedback at WordPress repo page.
- If anything else, then contact me in twitter.
Stay updated
I would be posting updates about this Plugin in my blog and in Twitter. 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 or follow me in Twitter.
Also checkout the other WordPress Plugins that I have created.
Readme Generator
This Readme file was generated using wp-readme, which generates readme files for WordPress Plugins.