Create a ScanCode.io pipeline to integrate Grimoire

[ziadhany]

Issues

• Closes: npm-health: Create a ScanCode.io pipeline to integrate Grimoire #2168

[ziadhany]

The pipeline input is:
https://github.com/expressjs/express.git

The expected JSON output file is:

{
  "repository": "https://github.com/expressjs/express.git",
  "score": {
    "value": 1.3072185774554448e-93,
    "metadata": {
      "ecosystem": "npm",
      "model": "health",
      "version": "0.1"
    }
  },
  "metrics": {
    "total_commits": 133,
    "total_contributors": 40,
    "total_organizations": 7,
    "pony_factor": 2,
    "elephant_factor": 1,
    "recent_organizations": 7,
    "recent_contributors": 40,
    "recent_commits": 133,
    "contributor_growth": -8,
    "contributor_growth_rate": -0.2962962962962963,
    "active_branches": 29,
    "days_since_last_commit": 1,
    "casual_regular_contributors_rate": 0.0,
    "returning_contributors": 0,
    "commits_over_periods_rate": 1.0,
    "coefficient_of_variation": 0.4666502450882076,
    "file_types_code": 56,
    "file_types_binary": 0,
    "file_types_other": 188,
    "commit_size_added_lines": 1562,
    "commit_size_removed_lines": 981,
    "message_size_total": 53218,
    "message_size_mean": 400.1353383458647,
    "message_size_median": 312,
    "developer_categories_core": 13,
    "developer_categories_regular": 27,
    "developer_categories_casual": 0,
    "commits_per_week": 2.5506849315068494,
    "commits_per_month": 10.931506849315069,
    "commits_per_year": 133.0,
    "found_file_license": 1,
    "found_file_adopters": 0
  }
}

[keshav-space]

Thanks @ziadhany, LGTM! few minor nits for your consideration.

[ziadhany]

@keshav-space I just updated the error messages and the function docstring.
Please have another look when you get a chance.

[ziadhany]

@keshav-space I just added the docs for the pipeline and its configuration. Please review them when you have some time.

---

[keshav-space]

@ziadhany, see suggestion below.

[keshav-space]

@TG1999 @ziadhany We're hardcoding this for now?

[ziadhany]

Yes, this is currently hardcoded in GrimoireLab, so the pipeline can only run with these values:

GRIMOIRELAB_ECOSYSTEM="npm-training-set"
GRIMOIRELAB_PROJECT="npm-popular-components"

We are planning to make these values configurable per ecosystem in the future.

In the meantime, according to my understanding, we will use the following hardcoded values for our pipeline:

GRIMOIRELAB_ECOSYSTEM="npm"
GRIMOIRELAB_PROJECT="health"

[ziadhany]

@keshav-space, these will be the hardcoded values according to Tushar’s last meeting. I’ll update the docs accordingly.

GRIMOIRELAB_ECOSYSTEM="npmlargerecosystem"
GRIMOIRELAB_PROJECT="NPMMostUsed"

[keshav-space]

Thanks @ziadhany, LGTM!