digitalkaoz / github-contributions-bundle
Symfony2 Bundle to show Github Contributions
Installs: 14
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 3
Forks: 0
Open Issues: 0
Type:symfony-bundle
Requires
- knplabs/github-api: ~1.1
- symfony/console: ~2.1
- symfony/framework-bundle: ~2.1
Suggests
- liip/doctrine-cache-bundle: for caching github responses
This package is not auto-updated.
Last update: 2024-11-05 02:27:28 UTC
README
This Bundle lets you display some Github Statistics in your Symfony2 Application. See https://help.github.com/articles/viewing-contributions for more Information.
Contribution Calendar
Repositories & Contributions
Installation
Add the Bundle with Composer
{ "require" : { "digitalkaoz/GithubContributionsBundle" : "~1.0" } }
For Caching add "liip/doctrine-cache-bundle": "~1.0"
as well!
Then update your Dependencies: php composer.phar update
Activate the Bundle in your AppKernel
public function registerBundles() { $bundles = array( // ... new digitalkaoz\GithubContributionsBundle\digitalkaozGithubContributionsBundle() ); return $bundles; }
Include the Routing File in your routing.yml
digitalkaoz_github_contributions: resource: "@digitalkaozGithubContributionsBundle/Resources/config/routing.xml" prefix: /github
Configuration
the full configuration looks like this:
# only needed if you want to cache the github reponses (recommend) liip_doctrine_cache: namespaces: github: type: file_system #nothing is required, but its recommended to use an api token and cache the results digitalkaoz_github_contributions: api_token: your_github_api_token cache_service: liip_doctrine_cache.ns.github username: your_github_username templates: contributions: digitalkaozGithubContributionsBundle:Contributions:contributions.html.twig activity_stream: digitalkaozGithubContributionsBundle:Contributions:activity.html.twig user_repos: digitalkaozGithubContributionsBundle:Contributions:user_repos.html.twig
Usage
View the Statistics
- visit
/github/contributions
to view a list of repositories you have contributed to - visit
/github/repos
to view a list of your own repositories - visit
/github/activity
to view your contribution calendar (like the github one)
Generate the Caches
the calculation of your contributions may take a while, so i build some commands to generate the caches eagerly from your console/cronjobs.
- run
app/console github:contribution-update contribution digitalkaoz
to update the contributions cache fordigitalkaoz
- run
app/console github:contribution-update repos digitalkaoz
to update the repos cache fordigitalkaoz
- run
app/console github:contribution-update activity digitalkaoz
to update the activity cache fordigitalkaoz
Tests
everything is well tested and under CI:
- https://travis-ci.org/digitalkaoz/GithubContributionsBundle
- https://scrutinizer-ci.com/g/digitalkaoz/GithubContributionsBundle/
- https://insight.sensiolabs.com/projects/a74d75ea-6aa5-4cf9-95dd-db4afbb5b2dc
TODO
- other useful stats?
- more generic approach for hooking own stats collectors?