Skip to content

ci: Create Github Action to Automate CODEOWNER update #1870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

ci: Create Github Action to Automate CODEOWNER update #1870

Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
98f22f8
create github action to automate codeowner change
yzh119 Oct 6, 2025
b5fb3db
upd
yzh119 Oct 6, 2025
a87e632
upd
yzh119 Oct 6, 2025
4e22b6b
upd
yzh119 Oct 6, 2025
f8a1a8c
upd
yzh119 Oct 6, 2025
d4df395
upd
yzh119 Oct 6, 2025
757cb32
upd
yzh119 Oct 6, 2025
3934511
upd
yzh119 Oct 6, 2025
560b434
Revert "upd"
yzh119 Oct 6, 2025
130b8b3
upd
yzh119 Oct 6, 2025
3b5e0aa
upd
yzh119 Oct 6, 2025
c402730
test: switch to pull_request with FLASHINFER_GITHUB_TOKEN
yzh119 Oct 6, 2025
f038549
chore: remove pull_request trigger from update-codeowners workflow
yzh119 Oct 6, 2025
9cc7e98
upd
yzh119 Oct 6, 2025
7547693
disable triggering from pull request
yzh119 Oct 6, 2025
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
113 changes: 113 additions & 0 deletions .github/workflows/update-codeowners.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
name: Update CODEOWNERS

on:
schedule:
# Run weekly on Monday at 00:00 UTC
- cron: '0 0 * * 1'
workflow_dispatch: # Allow manual triggering
pull_request:
branches:
- main

permissions:
contents: write
pull-requests: write

jobs:
update-codeowners:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- name: Checkout repository
uses: actions/[email protected]
with:
fetch-depth: 0 # Fetch full history for accurate analysis
token: ${{ secrets.GITHUB_TOKEN }}

- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'

- name: Run CODEOWNERS analyzer
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
python scripts/codeowner_analyzer.py \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we use --allowed-users-file here to explicitly control the group of trusted codeowners?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, do you want this list to be public or private?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think public is ok. This will give people an opportunity to either ask to be removed (if they no longer want to be a codeowner) or ask to be included (if they want to be but aren't for some reason).

--output .github/CODEOWNERS \
--depth 3 \
--min-commits 1 \
--days-back 180 \
--top-n 5 \
--no-api
- name: Check for changes
id: check_changes
run: |
# Check if CODEOWNERS file is new (unstaged) or has changes
if git ls-files --error-unmatch .github/CODEOWNERS >/dev/null 2>&1; then
# File is tracked, check for changes
if git diff --quiet .github/CODEOWNERS; then
echo "changed=false" >> $GITHUB_OUTPUT
echo "No changes detected in CODEOWNERS"
else
echo "changed=true" >> $GITHUB_OUTPUT
echo "Changes detected in CODEOWNERS"
fi
else
# File is untracked (newly created)
echo "changed=true" >> $GITHUB_OUTPUT
echo "CODEOWNERS file is new"
fi
- name: Create Pull Request
if: steps.check_changes.outputs.changed == 'true'
uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: |
chore: update CODEOWNERS based on git history
Auto-generated CODEOWNERS update based on commit activity over the last 365 days.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <[email protected]>
branch: auto-update-codeowners
base: main
delete-branch: true
title: 'chore: Update CODEOWNERS'
body: |
## Summary
This PR updates the CODEOWNERS file based on git commit history analysis from the last 365 days.
## Changes
- Updated `.github/CODEOWNERS` with current code ownership based on:
- Commit frequency
- File coverage
- Commit recency
## How to Review
1. Review the changes to `.github/CODEOWNERS`
2. Verify that the assigned owners are appropriate for each module
3. Make manual adjustments if needed before merging
## Notes
- This is an automated PR generated weekly
- Minimum commits threshold: 2
- Analysis period: 365 days
- Directory depth: 3 levels
---
🤖 This PR was automatically generated by the [update-codeowners workflow](.github/workflows/update-codeowners.yml)
labels: |
automated
maintenance
assignees: |
reviewers: |
28 changes: 25 additions & 3 deletions scripts/codeowner_analyzer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ def __init__(
github_token: Optional[str] = None,
use_api: bool = True,
allowed_users: Optional[List[str]] = None,
max_depth: int = 3,
top_n_owners: int = 3,
):
"""
Initialize the code owners analyzer.
Expand All @@ -43,10 +45,14 @@ def __init__(
github_token: Optional GitHub API token for higher rate limits
use_api: Whether to use GitHub API for email lookups (default: True)
allowed_users: Optional list of GitHub usernames to include (filters out others)
max_depth: Maximum directory depth for module detection (default: 3)
top_n_owners: Number of top owners to include in CODEOWNERS file (default: 3)
"""
self.repo_path = Path(repo_path).resolve()
self.min_commits = min_commits
self.days_back = days_back
self.max_depth = max_depth
self.top_n_owners = top_n_owners
self.module_owners: DefaultDict[str, DefaultDict[str, int]] = defaultdict(
lambda: defaultdict(int)
)
Expand Down Expand Up @@ -439,8 +445,10 @@ def get_modules(self) -> List[str]:

if file_ext in relevant_extensions:
# Add the directory and all parent directories as modules
# Limited by max_depth
path_parts = Path(dir_path).parts
for i in range(1, len(path_parts) + 1):
max_parts = min(len(path_parts), self.max_depth)
for i in range(1, max_parts + 1):
module = "/".join(path_parts[:i])
if not self.should_exclude(module):
modules.add(module)
Expand Down Expand Up @@ -654,10 +662,10 @@ def generate_codeowners_file(

for module, data in results.items():
if data["owners"]:
# Take top 3 owners or those with ownership score > 0.1
# Take top N owners or those with ownership score > 0.1
top_owners = [
owner
for owner in data["owners"][:3]
for owner in data["owners"][: self.top_n_owners]
if owner["ownership_score"] > 0.1
]

Expand Down Expand Up @@ -773,6 +781,18 @@ def main() -> int:
"--allowed-users-file",
help="File containing allowed GitHub usernames, one per line",
)
parser.add_argument(
"--depth",
type=int,
default=3,
help="Maximum directory depth for module detection (default: 3)",
)
parser.add_argument(
"--top-n",
type=int,
default=3,
help="Number of top owners to include in CODEOWNERS file (default: 3)",
)
Comment on lines +784 to +795
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

high

The new command-line arguments --depth and --top-n are defined to accept any integer. This allows negative values, which can lead to incorrect behavior:

  • A negative --depth will cause min(len(path_parts), self.max_depth) to likely return a negative number, resulting in no modules being detected without any warning.
  • A negative --top-n will be interpreted as a slice from the end of the owners list due to Python's slicing behavior (e.g., -1 selects all but the last owner). This is not the intended behavior for selecting the top N owners and will produce an incorrect CODEOWNERS file.

To prevent this, you should validate that these arguments are non-negative integers. You can do this by creating a custom type function for argparse.

Here is an example of a validator function you could add before main():

import argparse

def non_negative_int(value):
    """Custom argparse type for non-negative integers."""
    try:
        ivalue = int(value)
        if ivalue < 0:
            raise argparse.ArgumentTypeError(f"{value} is an invalid non-negative int value")
        return ivalue
    except ValueError:
        raise argparse.ArgumentTypeError(f"{value} is not an integer")

You can then use it in add_argument like this:
type=non_negative_int

Comment on lines +784 to +795
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

While adding these new configuration options is a great improvement, the pull request is missing tests to verify the new functionality. Adding tests is crucial for ensuring the features work as expected and to prevent future regressions.

Please consider adding unit tests that cover:

  • The --depth argument correctly limits the module hierarchy being generated.
  • The --top-n argument correctly selects the specified number of top owners.
  • Edge cases, such as --depth=0 or --top-n=0.


args = parser.parse_args()

Expand Down Expand Up @@ -811,6 +831,8 @@ def main() -> int:
github_token=args.github_token,
use_api=not args.no_api,
allowed_users=allowed_users,
max_depth=args.depth,
top_n_owners=args.top_n,
)
except ValueError as e:
print(f"Error: {e}", file=sys.stderr)
Expand Down