PortfoliOSS

A way to catalog your org's contributions to open source.

Introduction and Notes

On the Current Approach and Future Vision

This project helps answer an interesting question ("Who in our GitHub orgs contributes PRs to OSS projects?"). It currently solves it in a rudimentary way:

It's a console application
It uses a persistent stateful actor model to crawl GitHub (based on user-supplied token(s))
It persists events to a SQL server (in our current use case, SQL Server via Docker)
It replays those events into a view model (more tables in SQL Server and a view for reporting)
It uses PowerBI to pull from those tables and show results
It logs along the way (to Seq via Serilog)
- Fun fact: this was actually how the first version worked entirely. We scraped the log messages to an Excel file and generated a chart.

I'd love to get this to a place where we could publish a shiny front-end supported by the back-end running as a cluster and have things continually updated. I'd love even more to figure out a way to host this for many organizations to participate in, perhaps for a small fee to cover the hosting costs where all participating orgs pay an equal or proportionate version. But right now, let's be honest; this is a console app. It has a ways to go on that front.

On the Current State

A personal note from @SeanKilleen:

Some of this is...a little more rough than I'd normally publish. But, with limited time and resources, it was too easy to let the tool sit in a private repo and allow perfect to be the enemy of the good. This tool is solving a problem and it had been sitting too long in a private repo where only I could run it and improve it. It's time to put it out into the light, which I hope will drive more contributions and improvements.

Getting Started Running this

Our aim is to simplify the setup as much as possible.

Generating GitHub Tokens

In order to use this tool, you'll need to supply it with GitHub tokens for one or more users, which will enable the API requests to GitHub.

So, an important first step is generating (and asking others to) generate those tokens.

You or others can create a token at https://github.com/settings/tokens

As of this writing, we recommend providing the following permissions to the token you'll use for PortfoliOSS:

public_repo
read:org
read:public_key
read:user
read:enterprise
read:gpg_key

Setting up the Application Secrets to add GitHub Users

Right now, the app configuration expects a section that looks like the following:

{
  "PeopleAndTokens": {
    "Sean Killeen": "SEANS_GITHUB_TOKEN",
    "Person B": "THEIR_GITHUB_TOKEN",
  }
}

To keep tokens private when running locally, it's best to make use of User Secrets.

Right-click the console project and select Manage User Secrets.
- Alternately, use the dotnet user-secrets syntax from the command line. Let us know if you have trouble with it.
Add the people and tokens you'd like the app to use.

Note that we'll also likely be updating this config syntax to be an array of objects with properties in the near future.

Setting up the Orgs you want to track

Containers

SQL DB for persistence:

docker run -e "ACCEPT_EULA=Y" -e "SA_PASSWORD=yourStrong(!)Password" -p 1433:1433 --name portfolioss -d mcr.microsoft.com/mssql/server:2019-latest

⚠️ If you change this, you'll need to also update the connection strings throughout the project and the HOCON config. And if you're planning on using anything other than a local SQL DB, we might hold off on this project for a bit, because hard-coded strings like this in an app is definitely bad for public use.

Seq for logging:

docker run -p:5342:80 -p 5341:5341 -e "ACCEPT_EULA=Y" --name seq -d datalust/seq:latest

Create DB and Run Migrations within SQL Server

By default, the SQL Server container creates a master database. Probably best we don't operate in there though. We'll run the ef core migrations and set up our table structure in a portfolioss database.

Open a command prompt
Head to the src/app/PortfoliOSS.ModernData directory
Run the migrations against the SQL server on localhost (your container) by running dotnet ef database update.

At this point, you'll have the migrations applied for our table structure, but Akka will still need to create its event sourcing tables (which it will do because it has the SA password to the container at this point.)

Using the included PowerBI Report to View Data

You can find the PowerBI template in the reporting folder off of the root of this repository
Opening the template will attempt to load data from the localhost database specified earlier in the README, and with the same credentials.
If you have the database elsewhere or with different credentials, you'll want to change the data source. You can do this by:
- Opening the PowerBI report
- Waiting for data to load (or seeing an error if the existing data source isn't found)
- Go to File -> Options and settings -> Data source settings -> Data sources
- Clicking the data source and selecting Change Data Source
- Entering the new location of the data source, and any credentials when prompted.

Thank you to the OSS and Tools That Power Us

While this project encourages OSS contributions, it would be nothing itself without the projects it uses.

Akka.NET by Petabridge
Octokit.NET by the GitHub Octokit Team
Serilog (the OSS Logger) and Seq (the phenomenal commercial log sink with a free edition)
Microsoft's .NET -- .NET Core (and .NET 5-7) Framework, which is a world-class cross-platform framework that also happens to be open source these days.

SeanKilleen / PortfoliOSS