Feedback Wanted: SourceCred GitHub Workflows

Hey folks! We recently put together a sourcecred action for GitHub (now more commonly referred to as “workflows,” meaning that you can use sourcecred widgets along with sourcecred (via Docker containers) to run a Github workflow (on some event) to generate a nice community contribution svg for your repository!

Here is a quick example:

that is generated at usrse/usrse.github.io. There are currently two example workflows, one is automated to push directly to a branch at a scheduled time (e.g., once a week on Sunday) and the other will instead open a pull request for review first, run with the same time. You of course can use any GitHub events to trigger the workflows! There are links to these recipes and more information about the workflows in the repository README linked previously.

We’re looking for feedback or any other comments about if this integration is useful to you (even just to be fun or showcase your community) and if you would like to see other examples or types of generation. We can have discussion here, or if you prefer, open an issue on the sourcecred-action board. Thanks y’all!

4 Likes

Is the idea here that it makes it easy for anyone to run SourceCred on a repo? And when people do they’ll get a SourceCred graph like in the prototype as well as a collage of contributor GitHub profiles?

Or is the idea that you’ll be able to create a user profile collage based on the top contributors to your repo, but here “top contributors” is determined by a SourceCred contribution graph rather than naive metrics?

Is the idea here that it makes it easy for anyone to run SourceCred on a repo? And when people do they’ll get a SourceCred graph like in the prototype as well as a collage of contributor GitHub profiles?

It’s even simpler, this particular GitHub workflow will just generate the graphic. A person interested in the prototype could easily use the same containers to generate it, although that’s not the intention of the workflow.

Or is the idea that you’ll be able to create a user profile collage based on the top contributors to your repo, but here “top contributors” is determined by a SourceCred contribution graph rather than naive metrics?

Yes, that is on point! It’s intended to be a simple workflow to add in order to generate the graphic and promote your community / contributors.

1 Like

Cool!

Since the title of this post is “Feedback Wanted” I’ll weigh in more. It would be awesome if in addition to generating the user profile collage, it also generated the SourceCred graph (like in the prototype). Then you’d see the people and their relative contributions. Not sure how easy that is from an implementation standpoint, but it would be cool.

Also, since contributor collages are kind of a common thing people like maybe having it create the SourceCred graph could be an option, but not a requirement. That way if people just want a more representative, but still standard looking contributor collage they could just do that.

Hope that helps :slight_smile:

Yes that’s fantastic! I think that another action example (in this same repository) that exemplifies generation of the full prototype would make sense. Do you agree? I can work on this in the coming weekend!

1 Like

I do agree! That would be awesome :slight_smile:

1 Like

Quick question: what’s the difference between the widgets repo and the action repo?

The widgets repo serves a container developed by @Beanow that can be used to generate the graphic from the scores. The action repository then uses it.

1 Like