What I built

GitHub Action for easily generating a markdown file that lists all organisation contributors. The file can be linked e.g. to GitHub organisation profile page.

Category Submission

Maintainer Must-Haves

App Link

https://github.com/lauravuo/fetch-contributors-action

Screenshots

Result markdown file

The contributors file can be linked to organisation profile

Scheduled action updates the data regularly

Description

The action utilizes GitHub API for fetching the contributor data for all organisation repositories. It then generates a markdown file for the data and stores the result file to the repository.

The organisation maintainers can integrate this action to organisation's .github-repository so that the contributors data can be linked or even listed directly in the organisation's profile page.

Link to Source Code

https://github.com/lauravuo/fetch-contributors-action

Permissive License

Apache 2.0

Background

I have wanted to learn more about GitHub API for a while. In one open-source project, there became a need to list the organization's contributors to determine who has been making code contributions. The contributors can differ from the organization members, so the organization member listing does not give this information directly. This need was a perfect excuse to learn about the GitHub API more.

How I built it

I built a Javascript GitHub Action and learned a lot about crafting GitHub Actions using Typescript, and how to test them. I also know now more about the GitHub API in general.