https://github.com/davidstutz/wordpress-github

Wordpress GitHub plugin.
https://github.com/davidstutz/wordpress-github

github php wordpress-plugin

Last synced: 2 months ago
JSON representation

Wordpress GitHub plugin.

• Host: GitHub
• URL: https://github.com/davidstutz/wordpress-github
• Owner: davidstutz
• License: other
• Created: 2015-03-05T22:55:05.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2015-03-17T04:31:27.000Z (over 11 years ago)
• Last Synced: 2025-02-24T17:50:53.362Z (over 1 year ago)
• Topics: github, php, wordpress-plugin
• Language: PHP
• Size: 160 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# Wordpress GitHub

Lightweight Wordpress plugin providing acess to GitHub through shortcodes. The plugin is aimed to provide functionality to display repositories, users, commits and issues.

**Note:** After authenticating as described in [Settings](#settings), login and password are stored as plain text in the database.

![Settings for Authentication.](screenshot.png?raw=true 'Settings for Authentication.')

## Index

* [Installation](#installation)

* [Settings](#settings)

* [Shortcodes](#shortcodes)

    * [Commits](#commits)

    * [Issues](#issues)

    * [Releases](#releases)

## Installation

In `wp-content/plugins`, create a new folder `github` and put all files within this repository in this folder. In the backend, go to "Plugins" -> "Installed Plugins" and activate "Wordpress GitHub".

## Settings

In order to increase the rate limit, that is the number of allowed requests (see [https://developer.github.com/v3/#rate-limiting](https://developer.github.com/v3/#rate-limiting)), you can authenticate by setting your login and password in "Settings" > "GitHub". The form looks as shown above and displays how many requests have already been used after successfully authenticating.

## Shortcodes

The following list details the usage of all provided shortcodes.

### Commits

Use the following shortcode for displaying commits from several repositories:

    [github-commits repositories="davidstutz/wordpress-github,davidstutz/wordpress-user-biography" limit="5" format="m/d/Y" template="default"]

This will show the 5 most recent commits made to either `davidstutz/wordpress-github` or `davidstutz/wordpress-user-biography`. The generated HTML looks as follows:

    


        


            :repository

            @:sha: 

            :message  :user_login, :date

        

    


Additional templates can be added by adapting `Github::$templates`.

### Issues

Use the following shortcode for displaying issues from several repositories and all users:

    [github-issues repositories="davidstutz/wordpress-github,davidstutz/wordpress-user-biography" limit="5" format="m/d/Y" template="default"]

This will show the 5 most recent issues made to either `davidstutz/wordpress-github` or `davidstutz/wordpress-user-biography`. Additional templates can be implemented by adapting 'Github::$templates'. The generated HTML looks as follows:

    


        


            :repository

            #:number: 

            :title  :user_login, :state, :date

        

    


Additional templates can be added by adapting `Github::$templates`.

### Releases

Use the following shortcode for displaying releases of one or several repositories:

    [github-releases repositories="davidstutz/wordpress-github" limit="3" format="m/d/Y" template="default"]

This will show the 3 most recent releases of `davidstutz/wordpress-github` (note that this repository currently has no releases, try `davidstutz/bootstrap-multiselect` instead). The generated HTML looks as follows:

    


        


            :repository

            /:tag_name: 

            :name tar, zip, :date

        

    


Additional templates can be added by adapting `Github::$templates`.

## License

Copyright (C) 2015 David Stutz

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

See [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).