ci: adding gitignore check (googleapis#8560)

suztomo · web-flow · commit a8aafa41adc8 · 2022-10-10T10:38:53.000-04:00
* ci: added gitignore check

* fix: fixed gitignore
diff --git a/.github/workflows/generated_files_sync.yaml b/.github/workflows/generated_files_sync.yaml
@@ -95,3 +95,27 @@ jobs:
           bash generation/update_owlbot_postprocessor_config.sh
       - name: Fail if there's any difference
         run: git --no-pager diff --exit-code
+
+  gitignore_correctness:
+    name: Generated files should not match gitignore
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: checking any files matching gitignore
+      # By default, GitHub Actions's bash has '-e' option to fail immediately
+      # upon non-zero exit code. Not using it here to catch the exit code 1.
+      shell: /usr/bin/bash --noprofile --norc -o pipefail {0}
+      run: |
+        find . -type f -name '*.java' -not -path './.git/*' \
+            |git check-ignore --no-index --verbose --stdin
+        # https://git-scm.com/docs/git-check-ignore returns 1 when there's no
+        # matching files with the gitignore file.
+        # "--no-index" is needed to check against tracked files.
+        if [ "$?" == 1 ]; then
+          echo "No matching files. Good."
+          exit 0
+        else
+          echo "There are gitignore matching files. Please adjust .gitignore."
+          exit 1
+        fi
+
diff --git a/.gitignore b/.gitignore
@@ -48,9 +48,6 @@ nosetests.xml
 .DS_Store
 .classpath
 
-# Built documentation
-docs/
-
 # API key file containing value of GOOGLE_API_KEY for integration tests
 api_key
 
