ci(graphql,workflows): Format .md, .graphql, and workflow .yml files via prettier (#13220)

Author: asikowitz

.github/.codecov.yml

@@ -1,7 +1,7 @@
 comment:
   layout: "condensed_header, condensed_files, condensed_footer"
   hide_project_coverage: true
-  require_changes: false  # if true: only post the comment if coverage changes
+  require_changes: false # if true: only post the comment if coverage changes
 
 codecov:
   #due to ci-optimization, reports for modules that have not changed may be quite old
@@ -57,4 +57,4 @@ coverage:
     patch:
       default:
         target: 75% # for new code added in the patch
-        only_pulls: true
+        only_pulls: true

.github/ISSUE_TEMPLATE/--bug-report.md

@@ -3,15 +3,15 @@ name: "\U0001F41EBug report"
 about: Create a report to help us improve
 title: A short description of the bug
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots to help explain your problem.
 
 **Desktop (please complete the following information):**
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
- - Version [e.g. 22]
+
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
+- Version [e.g. 22]
 
 **Additional context**
 Add any other context about the problem here.

.github/ISSUE_TEMPLATE/datahub-v1-0-rc-bug-report.md

@@ -4,14 +4,14 @@ about: Report issues found in DataHub v1.0 Release Candidates
 title: "[v1.0-rc/bug] Description of Bug"
 labels: bug, datahub-v1.0-rc
 assignees: chriscollins3456, david-leifker, maggiehays
-
 ---
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
+
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
@@ -24,9 +24,10 @@ A clear and concise description of what you expected to happen.
 If applicable, add screenshots and/or screen recordings to help explain the issue.
 
 **System details (please complete the following information):**
- - DataHub Version Tag [e.g. v1.0-rc1]
- - OS: [e.g. iOS]
- - Browser [e.g. chrome, safari]
+
+- DataHub Version Tag [e.g. v1.0-rc1]
+- OS: [e.g. iOS]
+- Browser [e.g. chrome, safari]
 
 **Additional context**
 Add any other context about the problem here.

.github/actions/ci-optimization/action.yml

@@ -49,7 +49,7 @@ runs:
   using: "composite"
   steps:
     - name: Check trigger type
-      id: trigger  # Add an ID to reference this step
+      id: trigger # Add an ID to reference this step
       shell: bash
       run: |
         if [ "${{ github.event_name }}" == "workflow_dispatch" ]; then
@@ -104,4 +104,3 @@ runs:
           actions:
             - "datahub-actions/**"
             - "docker/datahub-actions/**"
-          

.github/actions/docker-custom-build-and-push/action.yml

@@ -156,4 +156,4 @@ runs:
         cache-to: |
           type=inline
 
-    # TODO add code for vuln scanning?
+    # TODO add code for vuln scanning?

.github/actions/ensure-codegen-updated/action.yml

@@ -1,5 +1,5 @@
-name: 'Ensure codegen is updated'
-description: 'Will check the local filesystem against git, and abort if there are uncommitted changes.'
+name: "Ensure codegen is updated"
+description: "Will check the local filesystem against git, and abort if there are uncommitted changes."
 
 runs:
   using: "composite"

.github/pr-labeler-config.yml

@@ -1,32 +1,32 @@
 ingestion:
-- changed-files:
-  - any-glob-to-any-file:
-    - "metadata-ingestion/**/*"
-    - "metadata-ingestion-modules/**/*"
-    - "metadata-integration/**/*"
+  - changed-files:
+      - any-glob-to-any-file:
+          - "metadata-ingestion/**/*"
+          - "metadata-ingestion-modules/**/*"
+          - "metadata-integration/**/*"
 
 devops:
-- changed-files:
-  - any-glob-to-any-file:
-    - "docker/**/*"
-    - ".github/**/*"
-    - "perf-test/**/*"
-    - "metadata-service/**/*"
+  - changed-files:
+      - any-glob-to-any-file:
+          - "docker/**/*"
+          - ".github/**/*"
+          - "perf-test/**/*"
+          - "metadata-service/**/*"
 
 product:
-- changed-files:
-  - any-glob-to-any-file:
-    - "datahub-web-react/**/*"
-    - "datahub-frontend/**/*"
-    - "datahub-graphql-core/**/*"
-    - "metadata-io/**/*"
+  - changed-files:
+      - any-glob-to-any-file:
+          - "datahub-web-react/**/*"
+          - "datahub-frontend/**/*"
+          - "datahub-graphql-core/**/*"
+          - "metadata-io/**/*"
 
 docs:
-- changed-files:
-  - any-glob-to-any-file:
-    - "docs/**/*"
+  - changed-files:
+      - any-glob-to-any-file:
+          - "docs/**/*"
 
 smoke_test:
-- changed-files:
-  - any-glob-to-any-file:
-    - "smoke-test/**/*"
+  - changed-files:
+      - any-glob-to-any-file:
+          - "smoke-test/**/*"

.github/pull_request_template.md

@@ -1,4 +1,3 @@
-
 ## Checklist
 
 - [ ] The PR conforms to DataHub's [Contributing Guideline](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md) (particularly [Commit Message Format](https://github.com/datahub-project/datahub/blob/master/docs/CONTRIBUTING.md#commit-message-format))

.github/scripts/generate_pre_commit.py

@@ -19,6 +19,7 @@ class ProjectType(Enum):
 
     JAVA = auto()
     PYTHON = auto()
+    PRETTIER = auto()
 
 
 @dataclass
@@ -27,6 +28,8 @@ class Project:
 
     path: str
     type: ProjectType
+    taskName: str | None = None  # Used for prettier projects
+    filePattern: str | None = None  # Used for prettier projects
 
     @property
     def gradle_path(self) -> str:
@@ -151,8 +154,12 @@ def generate_config(self) -> dict:
         for project in self.projects:
             if project.type == ProjectType.PYTHON:
                 hooks.append(self._generate_lint_fix_hook(project))
-            else:  # ProjectType.JAVA
+            elif project.type == ProjectType.JAVA:
                 hooks.append(self._generate_spotless_hook(project))
+            elif project.type == ProjectType.PRETTIER:
+                hooks.append(self._generate_prettier_hook(project))
+            else:
+                print(f"Warning: Unsupported project type {project.type} for {project.path}")
 
         config = {"repos": [{"repo": "local", "hooks": hooks}]}
 
@@ -203,6 +210,17 @@ def _generate_spotless_hook(self, project: Project) -> dict:
             "pass_filenames": False,
         }
 
+    def _generate_prettier_hook(self, project: Project) -> dict:
+        """Generate a prettier hook for projects."""
+        return {
+            "id": f"{project.project_id}-{project.taskName}",
+            "name": f"{project.taskName}",
+            "entry": f"./gradlew {project.gradle_path}:{project.taskName}",
+            "language": "system",
+            "files": project.filePattern,
+            "pass_filenames": False,
+        }
+
 
 class PrecommitDumper(yaml.Dumper):
     """Custom YAML dumper that maintains proper indentation."""
@@ -253,7 +271,21 @@ def main():
 
     # Find projects
     finder = ProjectFinder(root_dir)
-    projects = finder.find_all_projects()
+    prettier_projects = [
+        Project(
+            path="datahub-web-react",
+            type=ProjectType.PRETTIER,
+            taskName="mdPrettierWriteChanged",
+            filePattern="^.*\\.md$",
+        ),
+        Project(
+            path="datahub-web-react",
+            type=ProjectType.PRETTIER,
+            taskName="githubActionsPrettierWriteChanged",
+            filePattern="^\\.github/.*\\.(yml|yaml)$"
+        ),
+    ]
+    projects = [*prettier_projects, *finder.find_all_projects()]
 
     # Print summary
     print("Found projects:")
@@ -276,4 +308,4 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    main()

.github/scripts/pre-commit-override.yaml

@@ -6,4 +6,4 @@ repos:
         entry: ./gradlew :smoke-test:cypressLintFix
         language: system
         files: ^smoke-test/tests/cypress/.*\.tsx$
-        pass_filenames: false
+        pass_filenames: false