Skip to content
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.

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

Test codeowners validation #5

Closed
wants to merge 3 commits into from
Closed
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
17 changes: 16 additions & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# See ./org-repo.md
# See doc/org-repo.md

/README.md @infinisil
/CONTRIBUTING.md @infinisil
/LICENSE @infinisil @infinixbot

/.github/CODEOWNERS @infinisil @zimbatm
/.github/workflows @infinisil
/scripts @infinisil
/review-body.sh @infinisil

/doc/org-repo.md @infinisil @zimbatm
/doc/discourse.md @infinisil
/doc/github.md @infinisil
/doc/matrix.md @infinisil
/doc/moderation.md @infinisil
/doc/nixos-releases.md @infinisil
/doc/resources.md @infinisil
/doc/rfcs.md @infinisil
/doc/teams.md @infinisil
12 changes: 12 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ jobs:
name: Validate codeowners
runs-on: ubuntu-latest
steps:
- uses: cachix/install-nix-action@v26
with:
nix_path: nixpkgs=channel:nixos-unstable

- uses: actions/checkout@v4
with:
Expand Down Expand Up @@ -55,3 +58,12 @@ jobs:

# Specifies whether only teams are allowed as owners of files.
owner_checker_owners_must_be_teams: "false"

# The above validator doesn't currently ensure that people have write access: https://github.com/mszostok/codeowners-validator/issues/157
# So we're doing it manually instead
- name: Check that codeowners have write access
# Important that we run the script from the base branch,
# because otherwise a PR from a fork could change it to extract the secret
run: trusted-base/scripts/unprivileged-owners.sh untrusted-pr ${{ github.repository }}
env:
GH_TOKEN: "${{ secrets.OWNERS_VALIDATOR_GITHUB_SECRET }}"
50 changes: 50 additions & 0 deletions scripts/unprivileged-owners.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#!/usr/bin/env nix-shell
#!nix-shell -i bash --pure --keep GH_TOKEN -I nixpkgs=channel:nixpkgs-unstable -p codeowners github-cli

set -euo pipefail

tmp=$(mktemp -d)
trap 'rm -rf "$tmp"' exit

if (( $# != 2 )); then
echo "Usage: $0 PATH OWNER/REPO"
exit 1
fi

root=$1
repo=$2

# Writes all code owners into $tmp/codeowners, one user per line (without @)
while read -r -a fields; do
# The first field is the filename
unset 'fields[0]'
if [[ "${fields[1]}" != "(unowned)" ]]; then
(IFS=$'\n'; echo "${fields[*]##@}")
fi
done < <(cd "$root"; codeowners) |
sort -u > "$tmp/codeowners"

# Get all users with push access
gh api \
-H "Accept: application/vnd.github+json" \
-H "X-GitHub-Api-Version: 2022-11-28" \
--method GET \
-f permission=push \
/repos/"$repo"/collaborators \
-F per_page=100 \
--paginate \
--jq '.[].login' |
sort > "$tmp/collaborators"

# Figure out all the owners that aren't collaborators
readarray -t unprivilegedOwners < <(comm -23 "$tmp/codeowners" "$tmp/collaborators")

if (( "${#unprivilegedOwners[@]}" == 0 )); then
echo "All code owners have write permission"
else
echo "These code owners don't have write permission:"
for handle in "${unprivilegedOwners[@]}"; do
echo "- [ ] @$handle"
done
exit 1
fi
Loading