Skip to content
This repository has been archived by the owner on Oct 12, 2020. It is now read-only.

Use GitHub API v4, add options and improve trust algorithm #8

Merged
merged 11 commits into from
Jun 29, 2019

Conversation

Ullaakut
Copy link
Owner

Goal of this PR

This PR is a rewrite of 90% of Astronomer's code. It includes:

  • Using the GitHub v4 API in order to make fewer requests and get only the data that matters to astronomer
    • This increases scanning speed between 400% and 4500% compared to the 0.1.0 version.
  • Improves the trust algorithm computation
    • Private contributions count about twice less than other contributions for computing the overall trust
    • Issues, PRs, code reviews, commits and repository creations also have different weights when computing the overall trust
    • All percentiles from 5 to 95 are now computed when the --details flag is enabled
  • Adds two options
    • -d, --details which makes Astronomer print more detailed statistics
    • -c, --cachedir which allows users to specify a custom cache directory in which to store cache data. It defaults to ./data.
  • Update documentation
    • Update screenshots to use the latest version
    • Document new options
    • Document go install procedure
    • Update FAQ
    • Thank Renee French for the Go Gopher

Fixes #4
Fixes #6
Fixes #7

How to test it

  • docker build -t astronomer . should work
  • go build -o $GOPATH/bin/astronomer *.go should work
  • Run astronomer scans of small repositories using both the Docker image and the binary, playing around with the new options
  • If you can, run an astronomer scan on a big repository

@Ullaakut Ullaakut added documentation Improvements or additions to documentation enhancement New feature or request labels Jun 29, 2019
@Ullaakut Ullaakut self-assigned this Jun 29, 2019
@Ullaakut Ullaakut merged commit 7849d60 into master Jun 29, 2019
@Ullaakut Ullaakut deleted the use-github-apiv4 branch July 6, 2019 05:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add command line flags & options Thank Renee French for the Go gopher Use GitHub API v4
1 participant