Skip to content

Latest commit

 

History

History
17 lines (14 loc) · 1.41 KB

DEVELOPMENT.md

File metadata and controls

17 lines (14 loc) · 1.41 KB
Raw

Developing locally

  • Clone the repo: git clone https://github.com/cncf/devstats.git.
  • Checkout production branch (this is always a final working state on production machines).
  • Create branch from there.
  • If you want to createa PR, fork the repo instead of cloning and create PR from your fork.
  • Follow install instructions for your platform.
  • You don't need to have certbot SSL's, Apache proxy (it is only used to provide SSL and proxy to http Grafanas).
  • You don't need domain names, you can install locally and just test using "http://127.0.0.1:3001" etc.
  • You need to have GitHub OAuth token, either put this token in /etc/github/oauth file or specify token value via GHA2DB_GITHUB_OAUTH=deadbeef654...10a0 (here your token value).
  • If you want to use multiple tokens, create /etc/github/oauths file that contain list of comma separated OAuth keys or specify token values via GHA2DB_GITHUB_OAUTH=key1,key2,...,keyN
  • If you really don't want to use GitHub OAuth2 token, specify GHA2DB_GITHUB_OAUTH=- .This will force tokenless operation (via public API), it is a lot more rate limited (60 API points/h) than OAuth2 which gives 5000 API points/h.
  • GitHub OAuth token is only needed for ghapi2db and sync_issues tools.

Git LFS file differences

  • You can see differences of git-lfs stored files via: ./git-lfs-diff.sh revA revB dir/filename, for example: ./git-lfs-diff.sh HEAD^ HEAD github_users.com.