Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,5 @@ jobs:
run: uv run pytest
- name: Build
run: uv run contributor-network build
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
40 changes: 19 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,7 @@ uv run contributor-network bootstrap repos.txt --organization "My Org"

```shell
export GITHUB_TOKEN="your_token_here"
uv run contributor-network fetch
uv run contributor-network build
uv run contributor-network build dist
```

5. **Deploy** the `dist/` directory to any static host, or preview locally.
Expand All @@ -38,53 +37,52 @@ uv run contributor-network build

Get [uv](https://docs.astral.sh/uv/getting-started/installation/) and a GitHub personal access token with `public_repo` scope (e.g. via `gh auth token` if you have the [Github CLI](https://cli.github.com/)).

If you've only made changes to the javascript, you can rebuild the site with:
Rebuild the site from existing data (JS-only changes):

```sh
uv run contributor-network build
uv run contributor-network build --skip-fetch
```

If you've changed the config and need to re-fetch data from the Github API, run this (warning, this takes a while):
Full build (fetch + generate + assemble):

```sh
export GITHUB_TOKEN="your_token_here"
uv run contributor-network fetch
uv run contributor-network build dist
```

To list all configured contributors by category:
Discover repos your contributors work on:

```shell
uv run contributor-network list-contributors
uv run contributor-network discover from-contributors --min-contributors 2
```

To find new repositories that core contributors work on:
Discover community contributors from tracked repos:

```shell
uv run contributor-network discover --min-contributors 2 --limit 50
uv run contributor-network discover from-repositories --min-contributions 5
```

This queries GitHub to find repos where multiple core contributors have contributed, which are not yet in the configuration.
List contributors:

### Full workflow
```shell
uv run contributor-network list-contributors
```

To update the visualization with new data:
### Full workflow

```shell
# 1. Set your GitHub token
export GITHUB_TOKEN="your_token_here"

# 2. (Optional) Discover new repos to add
uv run contributor-network discover --min-contributors 2
# 2. (Optional) Discover new repos or contributors
uv run contributor-network discover from-contributors --min-contributors 2

# 3. Edit config.toml to add/remove repos or contributors

# 4. Fetch data from GitHub
uv run contributor-network fetch

# 5. Build the site
uv run contributor-network build
# 4. Build (fetch + CSVs + site)
uv run contributor-network build dist

# 7. Preview locally
# 5. Preview locally
cd dist && python -m http.server 8000
```

Expand Down
Loading