Add github action to generate "OSS Adopters" page

Open
  • Is something wrong?
#3 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
github-actions, python, shell
Domain
ci-cd, documentation

Research direction

Start by reading scripts/generate-adopters-info.sh and data/adopters.json to understand how the OSS Adopters page is generated and which data is curated. Add a periodic GitHub Actions workflow that runs the existing generation process and refreshes the page while preserving curated adopters.

Written by the indexing model from the issue text.

Description

The "OSS Adopters" page is automagically generated based on network information in our git repos. The script scripts/generate-adopters-info.sh was a quick and dirty hack to create the page using the Python tool, github-dependents-info. Some headline adopters come from data/adopters.json and can be curated as desired.

We should automate this using a GitHub action to be executed periodically, so the data on the page is fresh.

Image
Dominant language
Python
Stars
8
Forks
12
Avg merge
3m
Merged PRs (30d)
23

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from anchore/oss-docs

All issues in anchore/oss-docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.