README
¶
GitDog
Get in-depth analysis reports of a GitHub repository.
Quick Start
git clone git@github.com:live77/gitdog.git
cd gitdog
make build
bin/gitdog allinone -w workspace-go-echarts -r go-echarts/go-echarts
In this quick start demo, the go-echarts/go-echarts repository will be analyzed.
All the data will be stored in workspace-go-echarts folder.
A html file is generated in "./workspace-go-echarts/Contributors_and_Following_Relationships.html".
Open it in your Chrome, you will get this contributors' graph:
A Step Further
Generate a GitHub Token
It is strongly recommended that you obtain GitHub access token. Because if the token is not set, the rate limit allows for up to 60 requests per hour which is not enough for you to analysis a bit big github repository.
https://github.com/settings/tokens/new
Only "public_repo, read:org, read:user, repo:status" permission is required.
Use allinone cmd to analysis a bigger repository (e.g. kubesphere/console)
bin/gitdog allinone -w workspace-ks -r kubesphere/console -t the_github_token_you_generated
Details
Contributions
Documentation
¶
Overview ¶
Copyright © 2021 NAME HERE <EMAIL ADDRESS>
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Source Files
Directories