Contributor Map is a GitHub action that automatically generates an SVG world map with countries colored according to the number of received code contributions.
It uses GitHub API to get a list of repository contributors and their profile information. The location field from the public profile is used to determine the country from which the contribution came.
The action can generate a world map for any public GitHub repository.
Adding the following to an existing workflow would create a new "contributor-map.svg" file inside your repository.
- name: Contributor Map
uses: tunaitis/[email protected]The following example would generate a map showing contributions of the facebook/react repository and save it to your repository's data folder.
- name: Contributor Map
uses: tunaitis/[email protected]
with:
repository: facebbook/react
output: data/facebook-react.svgExample of the action inside a workflow that wouild run the action every Monday at 8AM UTC to create a map.
name: Create Contributor Map
on:
schedule:
- cron: "0 8 * * 1"
jobs:
build-and-push-image:
runs-on: ubuntu-latest
steps:
- name: Contributor Map
uses: tunaitis/contributor-map@v1 | name | required | description |
|---|---|---|
| palette | no | A comma-separated list of HTML color codes to define a custom color scheme. |
| repository | no | Name of repository to use for generating the map (e.g, facebook/react, golang/go). Current repository name will be used if the parameter is not provided. |
| output | no | Name of the file where to save the map. |
- SVG World Map by Cherkash and others, CC BY-SA 4.0, via Wikimedia Commons
- City database by GeoNames.org, CC BY 4.0
- Country and Region database from dr5hn/countries-states-cities-database, ODbL-1.0