Doc: Add page containing list of Database Migrations (apache#16181)

closes apache#11989

.pre-commit-config.yaml

@@ -440,6 +440,13 @@ repos:
         pass_filenames: false
         require_serial: true
         additional_dependencies: ['pyyaml']
+      - id: verify-db-migrations-documented
+        name: Verify that DB Migrations have been documented
+        language: python
+        entry: ./scripts/ci/pre_commit/pre_commit_migration_documented.py
+        files: ^airflow/migrations/versions/.*\.(py)$
+        pass_filenames: false
+        require_serial: true
       - id: sort-in-the-wild
         name: Sort INTHEWILD.md alphabetically
         entry: ./scripts/ci/pre_commit/pre_commit_sort_in_the_wild.sh

BREEZE.rst

@@ -2246,7 +2246,7 @@ This is the current syntax for  `./breeze <./breeze>`_:
                  restrict-start_date rst-backticks setup-order setup-extra-packages shellcheck
                  sort-in-the-wild sort-spelling-wordlist stylelint trailing-whitespace ui-lint
                  update-breeze-file update-extras update-local-yml-file update-setup-cfg-file
-                 version-sync www-lint yamllint
+                 verify-db-migrations-documented version-sync www-lint yamllint
 
         You can pass extra arguments including options to the pre-commit framework as
         <EXTRA_ARGS> passed after --. For example:

STATIC_CODE_CHECKS.rst

@@ -186,6 +186,8 @@ require Breeze Docker images to be installed locally:
 ----------------------------------- ---------------------------------------------------------------- ------------
 ``update-extras``                     Updates extras in the documentation
 ----------------------------------- ---------------------------------------------------------------- ------------
+``verify-db-migrations-documented``   Verify DB Migrations have been documented
+----------------------------------- ---------------------------------------------------------------- ------------
 ``www-lint``                          Static checks of js in airflow/www/static/js/ folder
 ----------------------------------- ---------------------------------------------------------------- ------------
 ``yamllint``                          Checks YAML files with yamllint

breeze-complete

@@ -148,6 +148,7 @@ update-breeze-file
 update-extras
 update-local-yml-file
 update-setup-cfg-file
+verify-db-migrations-documented
 version-sync
 www-lint
 yamllint

docs/apache-airflow/index.rst

@@ -116,3 +116,4 @@ unit of work and continuity.
     deprecated-rest-api-ref
     Configurations <configurations-ref>
     Extra packages <extra-packages-ref>
+    Database Migrations <migrations-ref>

scripts/ci/pre_commit/pre_commit_migration_documented.py

@@ -0,0 +1,67 @@
+#!/usr/bin/env python3
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+"""
+Module to verify that migrations added have been documented in
+docs/apache-airflow/migrations-ref.rst
+"""
+import glob
+import os
+import re
+import sys
+
+
+def check_migration_is_documented(migration_file, doc_path):
+
+    with open(migration_file) as m_file:
+        file_contents = m_file.read()
+    match = re.search(r"revision\s*=\s*['\"](\w*)['\"]", file_contents)
+    if match:
+        revision_id = match.group(1)
+        with open(doc_path) as doc_file:
+            doc_file_contents = doc_file.read()
+        if revision_id not in doc_file_contents:
+            return False, revision_id
+    return True, None
+
+
+if __name__ == '__main__':
+    project_root = os.path.join(os.path.dirname(__file__), os.pardir, os.pardir, os.pardir)
+
+    airflow_migrations_dir = os.path.join(project_root, "airflow/migrations/versions")
+
+    doc_path = os.path.abspath(os.path.join(project_root, "docs/apache-airflow/migrations-ref.rst"))
+    assert os.path.isfile(doc_path)
+
+    airflow_migrations_dir = os.path.abspath(airflow_migrations_dir)
+    migration_files = [f for f in glob.glob(f"{airflow_migrations_dir}/*.py")]
+
+    undocumented_migrations = []
+
+    for migration_file in migration_files:
+        is_documented, rev = check_migration_is_documented(migration_file=migration_file, doc_path=doc_path)
+        if not is_documented:
+            undocumented_migrations.append((migration_file, rev))
+
+    if undocumented_migrations:
+        print()
+        print(f"DB Migrations in following files have not been documented in '{doc_path}'")
+        print()
+        for undocumented_migration, rev in undocumented_migrations:
+            print(f"\t- {undocumented_migration} (Revision ID: '{rev}')")
+        sys.exit(1)