From df5c90843bfcfbf4420e9d41a74178667a817a92 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20K=C4=99pie=C5=84?= Date: Fri, 23 Dec 2022 13:21:47 +0100 Subject: [PATCH] Detect "ignored yet tracked" files in GitLab CI Ensure that no .gitignore file in the tree contains patterns matching files tracked by Git by adding a simple script that detects such situations and running that script as part of the "misc" job in the "precheck" stage of every GitLab CI pipeline. (cherry picked from commit 5b28da7ea0c378435736a8cf4021740055bad3ca) --- .gitlab-ci.yml | 1 + util/check-gitignore.sh | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+) create mode 100755 util/check-gitignore.sh diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 6566c2d4fe..beec448aef 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -450,6 +450,7 @@ misc: - test ! -f CHANGES.SE || sh util/check-line-length.sh CHANGES.SE - rm CHANGES.tmp - sh util/check-categories.sh + - sh util/check-gitignore.sh - if git grep SYSTEMTESTTOP -- ':!.gitlab-ci.yml'; then echo 'Please use relative paths instead of $SYSTEMTESTTOP.'; exit 1; fi - bash util/unused-headers.sh - bash util/xmllint-html.sh diff --git a/util/check-gitignore.sh b/util/check-gitignore.sh new file mode 100755 index 0000000000..d273dd464e --- /dev/null +++ b/util/check-gitignore.sh @@ -0,0 +1,23 @@ +#!/bin/sh + +# Copyright (C) Internet Systems Consortium, Inc. ("ISC") +# +# SPDX-License-Identifier: MPL-2.0 +# +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, you can obtain one at https://mozilla.org/MPL/2.0/. +# +# See the COPYRIGHT file distributed with this work for additional +# information regarding copyright ownership. + +ignored_yet_tracked="$(git ls-files --cached --ignored --exclude-standard | git check-ignore --verbose --stdin --no-index)" + +if [ -n "${ignored_yet_tracked}" ]; then + echo "The following .gitignore files contain patterns matching tracked files:" + echo + echo "${ignored_yet_tracked}" + echo + echo "Please adjust the contents of the above .gitignore files and/or the names of the tracked files." + exit 1 +fi