SNOW-1923653: Add AST generation acknowledgement to PR template and GitHub action to validate it (#3173)

1. Which Jira issue is this PR addressing? Make sure that there is an accompanying issue to your PR.

   [SNOW-1923653](https://snowflakecomputing.atlassian.net/browse/SNOW-1923653)

2. Fill out the following pre-review checklist:

   - [x] I am adding a new automated test(s) to verify correctness of my new code
      - [ ] If this test skips Local Testing mode, I'm requesting review from @snowflakedb/local-testing
   - [ ] I am adding new logging messages
   - [ ] I am adding a new telemetry message
   - [ ] I am adding new credentials
   - [ ] I am adding a new dependency
   - [ ] If this is a new feature/behavior, I'm adding the Local Testing parity changes.
   - [x] I acknowledge that I have ensured my changes to be thread-safe. Follow the link for more information: [Thread-safe Developer Guidelines](https://github.com/snowflakedb/snowpark-python/blob/main/CONTRIBUTING.md#thread-safe-development)
   - [x] If adding any arguments to public Snowpark APIs or creating new public Snowpark APIs, I acknowledge that I have ensured my changes include AST support. Follow the link for more information: [AST Support Guidelines](https://github.com/snowflakedb/snowpark-python/blob/main/CONTRIBUTING.md#ast-abstract-syntax-tree-support-in-snowpark)

3. Please describe how your code solves the related issue.

   This PR creates an AST acknowledgement checkbox in our repository's PR template along with a GitHub action to verify its usage. This is in the same vein as the thread safety acknowledgement checkbox and GitHub Action.

[SNOW-1923653]: https://snowflakecomputing.atlassian.net/browse/SNOW-1923653?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Author: sfc-gh-heshah

.github/pull_request_template.md

@@ -25,6 +25,7 @@ Please answer these questions before creating your pull request. Thanks!
    - [ ] I am adding a new dependency
    - [ ] If this is a new feature/behavior, I'm adding the Local Testing parity changes.
    - [ ] I acknowledge that I have ensured my changes to be thread-safe. Follow the link for more information: [Thread-safe Developer Guidelines](https://github.com/snowflakedb/snowpark-python/blob/main/CONTRIBUTING.md#thread-safe-development)
+   - [ ] If adding any arguments to public Snowpark APIs or creating new public Snowpark APIs, I acknowledge that I have ensured my changes include AST support. Follow the link for more information: [AST Support Guidelines](https://github.com/snowflakedb/snowpark-python/blob/main/CONTRIBUTING.md#ast-abstract-syntax-tree-support-in-snowpark)
 
 3. Please describe how your code solves the related issue.
 

.github/workflows/ast-check.yml

@@ -0,0 +1,51 @@
+name: AST Support Check
+
+on:
+  pull_request:
+    types: [opened, synchronize, labeled, unlabeled, edited]
+
+jobs:
+    check_ast_support:
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+
+            - name: Check for modified files
+              id: changed_files
+              uses: actions/github-script@v6
+              with:
+                  script: |
+                    const pr = context.payload.pull_request;
+                    const { data: files } = await github.rest.pulls.listFiles({
+                      owner: pr.base.repo.owner.login,
+                      repo: pr.base.repo.name,
+                      pull_number: pr.number,
+                    });
+                    const changedFiles = JSON.stringify(files.map(file => file.filename));
+                    console.log(`Changed files: ${changedFiles}`);
+                    return changedFiles;
+
+            - name: Verify AST support acknowledgement
+              if: steps.changed_files.outputs.result != ''
+              uses: actions/github-script@v6
+              with:
+                  script: |
+                    const changedFiles = JSON.parse(${{ steps.changed_files.outputs.result }});
+                    console.log(`changedFiles: ${changedFiles}`);
+                    const prBody = context.payload.pull_request.body;
+                    // Check if changed files are in snowpark/*.py. We only consider public Snowpark APIs in this check.
+                    if (changedFiles.some(file => file.match(/src\/snowflake\/snowpark\/[^/]+\.py/))) {
+                        console.log("Checking PR description for AST support acknowledgment...");
+                        if (!prBody.includes("[x] If adding any arguments to public Snowpark APIs or creating new public Snowpark APIs, I acknowledge that I have ensured my changes include AST support.")) {
+                            console.log("AST support acknowledgment not found in PR description.");
+                            console.log("Please acknowledge the AST support implications of your changes by adding '[x] If adding any arguments to public Snowpark APIs or creating new public Snowpark APIs, I acknowledge that I have ensured my changes include AST support.' to the PR description.");
+                            process.exit(1);
+                        } else {
+                            console.log("AST support acknowledgment found in PR description.");
+                        }
+                    } else {
+                        console.log("No critical files modified; skipping AST support check.");
+                    }

CONTRIBUTING.md

@@ -104,6 +104,12 @@ Once you have decided that the new component being added with required protectio
 
 An example PR to make auto temp table cleaner thread-safe can be found [here](https://github.com/snowflakedb/snowpark-python/pull/2309).
 
+### AST (Abstract Syntax Tree) Support in Snowpark
+
+If you are an open-source developer modifying existing Snowpark APIs (such as by adding a parameter to a `Dataframe` API), or creating new Snowpark APIs in your PR, please request a review from the `snowpark-ir` [team](https://github.com/orgs/snowflakedb/teams/snowpark-ir) and add the `snowpark-ast` [label](https://github.com/snowflakedb/snowpark-python/labels/snowpark-ast). You can also raise an issue on our [issue tracker](https://github.com/snowflakedb/snowpark-python/issues) with the `snowpark-ast` label and assign it to the `snowpark-ir` team to request a review. We will add code to support detailed logging of the usage of your modified or newly created API if relevant to your PR. After we do so, we will also update your PR description by completing the required AST support acknowledgement checkbox.
+
+If you are an internal developer, please ensure you complete the PR checklist for AST support found in the [Snowpark Python AST developer guide](https://docs.google.com/document/d/16K9jBv0pT6SkYbFTxNIQT9-bJjemE4niZTfc9mie6RQ/edit?tab=t.0), before completing the AST support acknowledgement checkbox.
+
 ## Tests
 
 The [README under tests folder](tests/README.md) tells you how to set up to run tests.