{"id":22188,"date":"2013-02-24T21:42:39","date_gmt":"2013-02-24T21:42:39","guid":{"rendered":"https:\/\/wordpress.org\/plugins-wp\/wp-github-tools\/"},"modified":"2016-08-11T15:35:39","modified_gmt":"2016-08-11T15:35:39","slug":"wp-github-tools","status":"publish","type":"plugin","link":"https:\/\/tah.wordpress.org\/plugins\/wp-github-tools\/","author":11709833,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_crdt_document":"","version":"1.4.4","stable_tag":"1.4.4","tested":"4.5.33","requires":"3.3","requires_php":"","requires_plugins":"","header_name":"WP GitHub Tools","header_author":"Vilmos Ioo","header_description":"","assets_banners_color":"1f1f1f","last_updated":"2016-08-11 15:35:39","external_support_url":"","external_repository_url":"","donate_link":"https:\/\/www.paypal.com\/cgi-bin\/webscr?cmd=_s-xclick&hosted_button_id=4K8F8YQMP84CJ","header_plugin_uri":"https:\/\/github.com\/vilmosioo\/Github-Tools-for-WordPress","header_author_uri":"http:\/\/vilmosioo.co.uk","rating":0,"author_block_rating":0,"active_installs":10,"downloads":2358,"num_ratings":0,"support_threads":0,"support_threads_resolved":0,"author_block_count":0,"sections":["description","installation","faq","changelog"],"tags":[],"upgrade_notice":{"1.4":"<p>Version 1.4 allows access to private repos and parses Markdown release notes to HTML.<\/p>","1.3":"<p>Version 1.3 allows you to display a repository&#039;s releases.<\/p>","1.2":"<p>Version 1.2 allows you to display customizable charts of your github commit activity.<\/p>","1.1":"<p>Version 1.1 brings OAuth, improved styling and better cache.<\/p>","1.0":"<p>Version 1.0 published!<\/p>"},"ratings":{"1":0,"2":0,"3":0,"4":0,"5":0},"assets_icons":[],"assets_banners":{"banner-772x250.png":{"filename":"banner-772x250.png","revision":"672718","resolution":"772x250","location":"assets"}},"assets_blueprints":{},"all_blocks":[],"tagged_versions":["1.0","1.1","1.2","1.2.2","1.2.3","1.2.4","1.2.5","1.2.6","1.3.1","1.3.3","1.3.4","1.3.5","1.4.4"],"block_files":[],"assets_screenshots":{"screenshot-1.png":{"filename":"screenshot-1.png","revision":"672718","resolution":"1","location":"assets"},"screenshot-2.png":{"filename":"screenshot-2.png","revision":"786401","resolution":"2","location":"assets"},"screenshot-3.png":{"filename":"screenshot-3.png","revision":"672718","resolution":"3","location":"assets"},"screenshot-4.png":{"filename":"screenshot-4.png","revision":"786414","resolution":"4","location":"assets"},"screenshot-5.png":{"filename":"screenshot-5.png","revision":"830255","resolution":"5","location":"assets"}},"screenshots":{"1":"Commits shortcode in action. An un-onrdered list of the latest commits is displayed, that you can style as you please using CSS.","2":"The settings page once you are connected to Github.","3":"The commits widget that you can use on any sidebar to deliver live updates for your projects.","4":"The cache preview system. You can manually refresh the cached data and you can view examples for the commits shortcode.","5":"The chart preview system. Currently in beta."},"jetpack_post_was_ever_published":false},"plugin_section":[],"plugin_tags":[54076,1673,14091,3971,162],"plugin_category":[43,59],"plugin_contributors":[94557],"plugin_business_model":[],"class_list":["post-22188","plugin","type-plugin","status-publish","hentry","plugin_tags-commit","plugin_tags-github","plugin_tags-repository","plugin_tags-tool","plugin_tags-widget","plugin_category-customization","plugin_category-utilities-and-tools","plugin_contributors-vilmosioo","plugin_committers-vilmosioo"],"banners":{"banner":"https:\/\/ps.w.org\/wp-github-tools\/assets\/banner-772x250.png?rev=672718","banner_2x":false,"banner_rtl":false,"banner_2x_rtl":false},"icons":{"svg":false,"icon":"https:\/\/s.w.org\/plugins\/geopattern-icon\/wp-github-tools_1f1f1f.svg","icon_2x":false,"generated":true},"screenshots":[{"src":"https:\/\/ps.w.org\/wp-github-tools\/assets\/screenshot-1.png?rev=672718","caption":"Commits shortcode in action. An un-onrdered list of the latest commits is displayed, that you can style as you please using CSS."},{"src":"https:\/\/ps.w.org\/wp-github-tools\/assets\/screenshot-2.png?rev=786401","caption":"The settings page once you are connected to Github."},{"src":"https:\/\/ps.w.org\/wp-github-tools\/assets\/screenshot-3.png?rev=672718","caption":"The commits widget that you can use on any sidebar to deliver live updates for your projects."},{"src":"https:\/\/ps.w.org\/wp-github-tools\/assets\/screenshot-4.png?rev=786414","caption":"The cache preview system. You can manually refresh the cached data and you can view examples for the commits shortcode."},{"src":"https:\/\/ps.w.org\/wp-github-tools\/assets\/screenshot-5.png?rev=830255","caption":"The chart preview system. Currently in beta."}],"raw_content":"<!--section=description-->\n<p>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. \nThe plugin will cache the GitHub response for a certain time period. You can change this value to any wordpress schedules you have isntalled (default: hourly, half-day, daily). To get more time frames you will need an additional plugin that extends the cron schedules.<\/p>\n\n<h4>Shortcodes<\/h4>\n\n<p><strong>[gist id='<em>gist_id<\/em>' ]<\/strong><\/p>\n\n<p>Embeds a gist in your post. Parameters:<\/p>\n\n<ul>\n<li><em>id<\/em> (required) The id of the gist you want to embed. <\/li>\n<\/ul>\n\n<p><strong>[commits repository='your-repository' count='max-count' title='your-title']<\/strong><\/p>\n\n<p>Displays the latest commits from your repository. Parameters:<\/p>\n\n<ul>\n<li><em>repository<\/em> (required) The name of the repository you wish to get. <\/li>\n<li><em>count<\/em> (optional) The number of commits to retrieve (order by date). Default: 5<\/li>\n<li><em>title<\/em> (optional) A title to display before the list (<em>h2<\/em>). Default: none<\/li>\n<\/ul>\n\n<p><strong>[releases repository='your-repository' count='max-count' title='your-title']<\/strong><\/p>\n\n<p>Displays the latest releases from your repository. Parameters:<\/p>\n\n<ul>\n<li><em>repository<\/em> (required) The name of the repository you wish to get. <\/li>\n<li><em>count<\/em> (optional) The number of releases to retrieve (order by date). Default: 5<\/li>\n<li><em>title<\/em> (optional) A title to display before the list (<em>h2<\/em>). Default: none<\/li>\n<\/ul>\n\n<p><strong>[chart repository='your-repository' width='chart-width' height='chart-height' class='additional-css-classes' color='bar-color' background='chart-background' count='commit-count' title='your-title']<\/strong><\/p>\n\n<p>Displays an activity chart for the given repository. Parameters:<\/p>\n\n<ul>\n<li><em>repository<\/em> (required) The name of the repository you wish to get. <\/li>\n<li><em>width<\/em> (optional) The width of the chart. Default: auto<\/li>\n<li><em>height<\/em> (optional) The height of the chart. Default: auto<\/li>\n<li><em>class<\/em> (optional) Additional CSS classes to add to the chart element. Default: ''<\/li>\n<li><em>color<\/em> (optional) The chart bar colors. Must be a valid color string (rgb, hex or name). Default: '#f17f49'<\/li>\n<li><em>background<\/em> (optional) The chart background color. Must be a valid color string (rgb, hex or name). Default: 'transparent'<\/li>\n<li><em>count<\/em> (optional) The number of commits to retrieve (order by date). Default: 30<\/li>\n<li><em>title<\/em> (optional) A title to display before the list (<em>h2<\/em>). Default: none<\/li>\n<\/ul>\n\n<h4>PHP functions<\/h4>\n\n<p>Feel free to use the Gihub helper class in your theme or plugin development.<\/p>\n\n<pre><code>&lt;?php WP_Github_Tools_API::get_repos($user, $access_token); ?&gt;\n\n&lt;?php WP_Github_Tools_API::get_user($user, $access_token); ?&gt;\n\n&lt;?php WP_Github_Tools_API::get_commits($repo, $user, $access_token); ?&gt;\n\n&lt;?php WP_Github_Tools_API::get_releases($repo, $user, $access_token); ?&gt;\n\n&lt;?php WP_Github_Tools_API::get_gists($user, $access_token); ?&gt;\n<\/code><\/pre>\n\n<h4>Contribute!<\/h4>\n\n<p>If you have suggestions for a new add-on, feel free to contact me on <a href=\"http:\/\/twitter.com\/vilmosioo\">Twitter<\/a>. Alternatively, you can fork the plugin from <a href=\"https:\/\/github.com\/vilmosioo\/Github-Tools-for-WordPress\">Gihub<\/a><\/p>\n\n<!--section=installation-->\n<ol>\n<li>Download the plugin files and upload them to your <code>\/wp-content\/plugins\/<\/code> directory\n\n<ol>\n<li>Activate the plugin through the 'Plugins' menu in WordPress<\/li>\n<li>Create a Github application (make sure the redirect url points back to the github tools settings page)<\/li>\n<li>Add your client ID and secret<\/li>\n<li>Connect to Github<\/li>\n<li>Ready to go!<\/li>\n<\/ol><\/li>\n<\/ol>\n\n<!--section=faq-->\n<p>Send any questions directly to <a href=\"http:\/\/twitter.com\/vilmosioo\">me<\/a>!<\/p>\n\n<!--section=changelog-->\n<h4>1.4<\/h4>\n\n<ul>\n<li>Provides access to private repos. Current users will need to re-authorize their repository.<\/li>\n<li>Markdown-formatted release notes are rendered into HTML.<\/li>\n<\/ul>\n\n<h4>1.3<\/h4>\n\n<ul>\n<li>Added custom widget to display repository releases.<\/li>\n<li>Implemented custom shortcode to display repository releases.<\/li>\n<\/ul>\n\n<h4>1.2<\/h4>\n\n<ul>\n<li>Added Chart functionality (beta) that allows users to display their commit activity using a graph.<\/li>\n<li>Enabled automatic build to deliver updates more quickly.<\/li>\n<li>Minifying assets for greater performance.<\/li>\n<\/ul>\n\n<h4>1.1<\/h4>\n\n<ul>\n<li>Using OAuth to connect to Github<\/li>\n<li>Improved settings page<\/li>\n<li>Better caching system <\/li>\n<\/ul>\n\n<h4>1.0<\/h4>\n\n<ul>\n<li>Added custom widget to display repository commits.<\/li>\n<li>Implemented custom shortcode to display repository commits.<\/li>\n<li>Implemented custom shortcode to embed gists.<\/li>\n<li>Customizable cache system.<\/li>\n<li>Live validation of GitHub usernames.<\/li>\n<\/ul>","raw_excerpt":"A plugin that inserts dynamic updates for any GitHub repository.","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin\/22188","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin"}],"about":[{"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/types\/plugin"}],"replies":[{"embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/comments?post=22188"}],"author":[{"embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wporg\/v1\/users\/vilmosioo"}],"wp:attachment":[{"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/media?parent=22188"}],"wp:term":[{"taxonomy":"plugin_section","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_section?post=22188"},{"taxonomy":"plugin_tags","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_tags?post=22188"},{"taxonomy":"plugin_category","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_category?post=22188"},{"taxonomy":"plugin_contributors","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_contributors?post=22188"},{"taxonomy":"plugin_business_model","embeddable":true,"href":"https:\/\/tah.wordpress.org\/plugins\/wp-json\/wp\/v2\/plugin_business_model?post=22188"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}