https://github.com/gofunky/update-codeowners
generate and update GitHub's CODEOWNERS file based on the git fame of individual files
https://github.com/gofunky/update-codeowners
code code-review codeowners fame generate git git-fame github-actions github-codeowners owners pull-requests review update
Last synced: about 4 hours ago
JSON representation
generate and update GitHub's CODEOWNERS file based on the git fame of individual files
- Host: GitHub
- URL: https://github.com/gofunky/update-codeowners
- Owner: gofunky
- License: gpl-3.0
- Created: 2020-09-13T13:49:31.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T01:34:05.000Z (about 3 years ago)
- Last Synced: 2024-03-15T14:22:44.181Z (almost 2 years ago)
- Topics: code, code-review, codeowners, fame, generate, git, git-fame, github-actions, github-codeowners, owners, pull-requests, review, update
- Language: Shell
- Homepage:
- Size: 116 KB
- Stars: 6
- Watchers: 2
- Forks: 2
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# update code owners action
[](https://github.com/gofunky/update-codeowners/actions)
[](https://app.renovatebot.com/dashboard#github/gofunky/update-codeowners)
[](https://www.codefactor.io/repository/github/gofunky/update-codeowners)
[](https://github.com/gofunky/update-codeowners/blob/master/LICENSE)
[](https://github.com/gofunky/update-codeowners/commits/master)
This is a [GitHub Action](https://github.com/features/actions) that uses [git-fame](https://pypi.org/project/git-fame) to generate and update GitHub's CODEOWNERS file based on the git fame of individual files.
## What does it do?
GitHub's [CODEOWNERS](https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners)
feature doesn't provide any method for keeping the code owners list updated automatically.
This action solves this by determining code owners based on the git fame of each file.
Authors don't have to be asked for their addition based on subjective criteria anymore.
## Inputs
### distribution
The distribution input defines the minimum percentage of code lines that are required for a contributor to being
considered a code owner.
Set it to any integer without the percent character to override the default.
### granular
By default, this action checks all files in the root, but groups recursive files into their parent directories.
Set this input to any non-zero value (e.g. `true`) to enable full coverage of all recursive files.
### path
This defines the path to the CODEOWNERS file.
The default uses the path to the `.github` directory.
### token
A GitHub token has to be set if `inputs.username` is enabled.
This is necessary because the GitHub API has a rate limit.
The default token has sufficient permissions for the API.
### username
By default, this action uses the email addresses of users.
Set this input to any non-zero value (e.g. `true`) to derive the GitHub usernames and use them instead.
## Example
This is a typical example for a pull request workflow.
It should suffice to trigger it on few event types of pull request events only.
That also gives the author the possibility to remove themselves from the owners list optionally.
Make sure to use `fetch-depth: 0` because otherwise, no git fame will be detected due to the lack of history.
``` yml markdown-add-files
name: codeowners
on:
pull_request_target:
paths-ignore:
- '**/CODEOWNERS'
- 'LICENSE'
branches:
- master
types:
- ready_for_review
- review_request_removed
- reopened
- labeled
jobs:
update:
runs-on: ubuntu-latest
# only apply on unmerged pull requests
if: github.event.pull_request.merged_by == ''
steps:
- name: checkout code
uses: actions/checkout@v2.3.4
with:
# this only makes sure that forks are built as well
repository: ${{ github.event.pull_request.head.repo.full_name }}
ref: ${{ github.head_ref }}
# the fetch depth 0 (=all) is important
fetch-depth: 0
# the token is necessary for checks to rerun after auto commit
token: ${{ secrets.PAT }}
- name: update code owners
uses: gofunky/update-codeowners@v0.3.1
with:
distribution: 25
username: true
- uses: mszostok/codeowners-validator@v0.5.1
id: validation
if: ${{ steps.committed.outputs.changes_detected == 'true' }}
with:
checks: files,owners,duppatterns
# the token is required only if the `owners` check is enabled
github_access_token: ${{ secrets.PAT }}
- name: commit changed files
id: committed
if: ${{ steps.committed.outputs.changes_detected == 'true' }}
uses: stefanzweifel/git-auto-commit-action@v4.7.2
with:
commit_message: 'chore(meta): update code owners'
file_pattern: .github/CODEOWNERS
- uses: christianvuerings/add-labels@v1.1
if: ${{ steps.committed.outputs.changes_detected == 'true' }}
with:
labels: owned
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```