Merge branch 'revert2' into 'main'

Revert the "Automatically redeploy changes to owners.yaml" change

See merge request redhat/centos-stream/src/kernel/documentation!644

Author: prarit

.gitlab-ci.yml

@@ -6,7 +6,7 @@ stages:
   - container prep
   - sanity check
   - build
-  - deploy 
+  - check
 
 # https://docs.gitlab.com/ee/ci/yaml/README.html#switch-between-branch-pipelines-and-merge-request-pipelines
 # if a MR is opened: run a detached MR pipeline
@@ -81,13 +81,12 @@ build:
     - .fdo.distribution-image@alpine
     - .common_variables
   script:
-    # call make at root directory to do a 'fullbuild'
+    - cd scripts
     - make
   artifacts:
     paths:
-      - info/RHMAINTAINERS
-      - info/CODEOWNERS
-      - info/owners.yaml
+      - scripts/yaml2CODEOWNERS
+      - scripts/yaml2RHMAINTAINERS
 
 .pages:
   stage: build
@@ -114,8 +113,6 @@ build:
     - public
 
 pages CI check:
-  # This stage, while still "deploying" a gitlab pages instance, does *not* run
-  # on the `main` branch.
   extends:
   - .pages
   before_script:
@@ -129,33 +126,40 @@ pages CI check:
       when: never
     - when: on_success
 
-deploy:
-  stage: deploy 
-  dependencies:
-    - build
+check:
+  stage: check
   extends:
     - .fdo.distribution-image@alpine
     - .common_variables
   script:
-    # we've already run 'make' and the artifacts are available.
-    # so just deploy code to main
-    - git config user.name "Gitlab Runner"
-    - git config user.email ""
-    - git fetch origin
-    - git add info/owners.yaml info/RHMAINTAINERS info/CODEOWNERS
-    # make it so that job will not fail if there is nothing to commit
-    - git diff-index --quiet HEAD || git commit -m "[Gitlab CI/CD] Automated rebuild of info/*"
-    - git push https://gitlab-ci-token:$MAKE_MAINT@gitlab.com/redhat/centos-stream/src/kernel/documentation.git HEAD:main 
+    # rebuild the current files
+    - make
 
-  rules:
-    - if: '$CI_PROJECT_NAMESPACE == "redhat/centos-stream/src/kernel" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-    - changes:
-      - info/owners.yaml
+    # clean up cache
+    - rm -f .failed
+
+    # check that the committed files matched
+    - git diff --exit-code || touch .failed
+    - |
+      if [[ -e .failed ]]
+      then
+        echo '-----------------------------------------------------------------'
+        echo ''
+        echo ' Looks like the files scripts/CODEOWNERS or scripts/RHMAINTAINERS'
+        echo ' have not been regenerated and checked in this commit.'
+        echo ''
+        echo ' Please run the following command before committing:'
+        echo '        ./scripts/yaml2CODEOWNERS info/owners.yaml > info/CODEOWNERS'
+        echo '        ./scripts/yaml2RHMAINTAINERS info/owners.yaml > info/RHMAINTAINERS'
+        echo ''
+        echo '-----------------------------------------------------------------'
+        exit 1
+      fi
 
 pages:
   extends:
   - .pages
-  stage: deploy 
+  stage: check
   rules:
-    - if: '$CI_PROJECT_NAMESPACE == "redhat/centos-stream/src/kernel" && $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    - when: never

README.md

@@ -43,8 +43,15 @@ accompanied by a description of the modifications.  In most cases, a simple
 explanation will do (for example, "Update x86 maintainers"), however the
 maintainers may ask for a more detailed write-up.
 
-Changes are only accepted for the owners.yaml file, as the RHMAINTAINERS and
-CODEOWNERS files are generated automatically on-merge.
+Standalone changes are NOT accepted for the RHMAINTAINERS or CODEOWNERS files,
+and changes are only accepted for the owners.yaml file.  Merge requests that
+modify owners.yaml changes must include associated changes to RHMAINTAINERS &
+CODEOWNERS.  These secondary files can be generated using these commands
+executed from the top level of documentation:
+
+```
+	make # requires minimum golang version 1.14
+```
 
 Users making changes must include a "Signed-off-by:" tag on all commits that
 acknowledges the DCO, https://developercertificate.org.