deps.cloud Hacktoberfest tooling

This repository contains tooling to help support organizations participating in Hacktoberfest.

deps.cloud is a tool to help understand how projects relate to one another. It works by detecting dependencies defined in common manifest files (pom.xml, package.json, go.mod, etc). Using this information, we’re able to answer questions about project dependencies.

• What versions of k8s.io/client-go do we depend on?
• Which projects use eslint as a non-dev dependency?
• What open source libraries do we use the most?

Prerequisites

In order to use this repository, you will need a deployment of deps.cloud running.

Identifying contribution candidates

identify-contribution-candidates looks for open source library use across your company. It scores each project by how often it's used in your projects. We then look up its source using LibrariesIO.

1. Download the latest command from the releases tab.

2. Create a config.yaml file. We use this to identify your companies modules in the graph.

   company_patterns:
     - ^.*depscloud.*$

3. Configure your deps.cloud endpoint.

   export DEPSCLOUD_BASE_URL=http://localhost:8080

4. Obtain an API Key from libraries.io

   export LIBRARIESIO_API_KEY=123wxyz

5. Run identify-contribution-candidates

That's it! At the end of it's run, it writes out a candidate.json file.

[
  {
    "repository_url": "https://github.com/mjpitz/go-gracefully",
    "score": 4
  }
]

Feeding into Mariner

Indeed's Mariner project takes in a list of GitHub repositories and their scores. Because Mariner only works with GitHub repositories, we will need to filter and format accordingly. After feeding this information through Mariner, you will be left with a set of tickets. These tickets are not only great for getting started in open source, but also have a direct impact on your company.

Support

Join our mailing list to get access to virtual events and ask any questions there.

We also have a Slack channel.

Branch Checks