Microsoft.CodeTransparency Python SDK

.coveragerc

@@ -6,6 +6,7 @@ omit =
 	*/test*
 	env*
 	*/_serialization.py
+	*/azure/ai/ml/_restclient
 
 [paths]
 source =
@@ -20,8 +21,10 @@ exclude_lines =
 	if headers:
 	if response.status_code not in
 	if TYPE_CHECKING:
+	@overload
 omit =
 	*/test*
 	env*
 	*/_serialization.py
-	*/sms/_shared/*
+	*/sms/_shared/*
+	*/azure/ai/ml/_restclient/*

.github/ISSUE_TEMPLATE/z-learn-feedback.yml

@@ -50,6 +50,12 @@ body:
       required: true
     attributes:
       label: Document Version Independent Id
+  - type: input
+    id: platformId
+    validations:
+      required: true
+    attributes:
+      label: Platform Id
   - type: input
     id: author
     validations:

.github/copilot-instructions.md

@@ -0,0 +1,136 @@
+# Copilot Instructions
+
+
+# General Repository Guidelines
+- DO check this [website](https://azure.github.io/azure-sdk/python_design.html), and link to pages found there, if possible, when asked about guidelines, or guidance on how to write SDKs. The general guidelines for SDK in this repo are defined there.
+- DO ensure folks have the appropriate setup when working with this repository. Use the verify_setup tool in the azure-sdk-validation server.
+
+
+# Generating an SDK From TypeSpec
+
+## Agent Context
+- Check if there are any TypeSpec project paths in the context. If there are, use those paths to locally generate the SDK from the tsp-config.yaml file. If there 
+are no TypeSpec project paths in the context, ask the user for the path to the tsp-config.yaml file. If the user does not have a path, ask them to provide one.
+
+## Prerequisites
+- The user should have a GitHub account and be logged in to GitHub using the GitHub CLI `gh auth login`.
+- The user should have a GitHub Personal Access Token (PAT) with the `repo` scope.
+
+## Basic Rules:
+### When running tsp-client commands:
+-  If syncing from a local repo, do not grab a commit hash.
+- Do not manually create directories. The command will create the directories for you.
+- If asked to sync or generate `package-name` we need to find the path to the package's tsp-location.yaml
+ in the azure-sdk-for-python repo and run the command in the same directory.
+- If provided a url to a tspconfig.yaml ensure it has the most recent commit hash of the tspconfig.yaml file
+ instead of a branch name like `main`. If the url does not have a commit hash, use the GitHub API to get the most recent commit hash of the tspconfig.yaml file.
+  If you are unable to do this, ask the user to provide the correct url.
+   `curl -s "https://api.github.com/repos/Azure/azure-rest-api-specs/commits?path=,path to tspconfig.yaml>&per_page=1"`
+- Ensure that node, python, tox, and the required dependencies are installed in your environment (@azure-tools/typespec-client-generator-cli)
+
+
+## Steps to Generate:
+
+### Step 1: Validate the correct environment is set up
+- Check if the user has the correct environment set up. If not, guide them to set it up. 
+- Using the `verify_setup` tool in the azure-sdk-validation server is a good way to do this.
+
+### Step 2: Run the correct tsp-client command(s):
+- The typspec-python mcp server tools should be used to run the commands.
+- If any of the commands fail, check the error message and guide the user to fix the issue.
+   - If a command fails due to a TypeSpec error, direct the user back to the TypeSpec to fix the error.
+- If the user is generating a new package, ensure that the package name is valid and follows the naming conventions for Python packages.
+
+### Step 3: Validate the generated SDK and Fix the issues
+   - Installing the newly generated package and its dev_requirements in a .venv and installing tox.
+   - Use the tox mcp tool from the azure-sdk-validation server to run the following validations when possible:
+      - Running pylint validation using tox: `tox -e pylint -c [path to tox.ini] --root .`
+      - Running mypy type checking using tox: `tox -e mypy -c [path to tox.ini] --root .`
+      - Running pyright validation using tox: `tox -e pyright -c [path to tox.ini] --root .`
+      - Running verifytypes validation using tox: `tox -e verifytypes -c [path to tox.ini] --root .`
+   - Fix issues found during validation.
+   - If there are any issues that cannot be fixed, please ask the user to fix them and then come back to proceed with the next step.
+
+### Step 4: Post-Processing of the SDK
+- Create a CHANGELOG.md entry for the changes made. If there is no CHANGELOG.md file, create one in the root directory of the package. If the package version is not correct, update it in _version.py and the CHANGELOG entry.
+- Confirm that the package version in the most recent CHANGELOG entry is correct based on the API spec version and the last released package version. 
+
+The CHANGELOG entry should look like:
+```markdown
+# Release History
+
+## 1.0.0 (YYYY-MM-DD)
+
+### Features Added
+  - Added a new feature to do X.
+
+### Breaking Changes
+   - Changed the way Y is done, which may break existing code that relies on the old behavior.
+
+### Bugs Fixed
+   - Fixed a bug that caused Z to not work as expected.
+
+### Other Changes
+   - Updated the documentation to reflect the new changes.
+   - Refactored the code to improve readability and maintainability.
+```
+
+### Step 5: Commit and Push the Changes
+- Display the list of changed files in the repository and prompt the user to confirm the changes. Ignore uncommitted changes in .github and .vscode folders.
+   - If the user confirms:
+      - Prompt the user to commit the changes:
+         - Run `git add <changed files>` to stage the changes.
+         - Run `git commit -m "<commit message>"` to commit the changes.
+      - Push the changes to the GitHub remote, ensuring the branch name is not "main."
+         - Run `git push -u origin <branch name>` to push the changes.
+         - If the push fails due to authentication, prompt the user to run `gh auth login` and retry the push command.
+         - If the user does not confirm, prompt them to fix the changes and re-run validation.
+
+### Step 6: Manage Pull Requests
+- Check if a pull request exists for the current branch:
+   - If a pull request exists, inform the user and display its details.
+   - If no pull request exists:
+      - Ensure the current branch name is not "main." If it is, prompt the user to create a new branch using `git checkout -b <branch name>`.
+      - Push the changes to the remote branch. If the branch does not exist on GitHub, create it and push the changes.
+      - Generate a title and description for the pull request based on the changes. Prompt the user to confirm or edit them.
+      - Prompt the user to select the target branch for the pull request, defaulting to "main."
+      - Create the pull request in DRAFT mode with the specified project, target branch, title, and description.
+   - Retrieve and display the pull request summary, including its status, checks, and comments. Highlight any action items.
+   - Return the link to the pull request for the user to review.
+
+### Step 7: Finalize the Process
+ - Prompt the user to review the pull request and make any necessary changes.
+ - If the user is satisfied with the pull request guide them to go back to the TypeSpec project and make any necessary changes.
+
+
+# Pylint
+
+## Running Pylint
+- When asked how to run pylint, or given a command to run pylint, DO check [this website](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/pylint_checking.md) and guide the user based on the information you find there. 
+- Do run pylint using the command `tox -e pylint --c <path to tox.ini> --root .` if the user is working on a specific file. The path to the tox.ini file by default is `azure-sdk-for-python/eng/tox/tox.ini`
+- For formatting the tox command DO check [this website](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/tests.md#tox) and guide the user based on the information you find there.
+
+
+
+## Fixing Pylint Warnings
+
+### Dos and Don'ts
+- DO use the table in https://github.com/Azure/azure-sdk-tools/blob/main/tools/pylint-extensions/azure-pylint-guidelines-checker/README.md and the code examples as a guide on how to fix each rule. 
+- DO refer to the pylint documentation: https://pylint.readthedocs.io/en/stable/user_guide/checkers/features.html.
+
+
+- DO NOT solve a pylint warning if you are not 100% confident about the answer. If you think your approach might not be the best, stop trying to fix the warning and leave it as is.
+- DO NOT create a new file when solving a pylint error, all solutions must remain in the current file.
+- DO NOT import a module or modules that do not exist to solve a pylint warning.
+- DO NOT add new dependencies or imports to the project to solve a pylint warning.
+- DO NOT make larger changes where a smaller change would fix the issue.
+- DO NOT change the code style or formatting of the code unless it is necessary to fix a pylint warning.
+- DO NOT delete code or files unless it is necessary to fix a warning.
+
+
+# MyPy
+
+## Running MyPy and Fixing MyPy Warnings
+- When asked how to run mypy, or given a command to run mypy, DO check [this website](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/tests.md#tox) and guide the user based on the information you find there.
+- Do check this website on guidance on how to best fix MyPy issues [website link](https://github.com/Azure/azure-sdk-for-python/blob/main/doc/dev/static_type_checking_cheat_sheet.md)
+- DO use a python 3.9 environment that is compatible with the code you are working on. If you are not sure, please ask the user for the python version they are using. 

.github/prompts/next-pylint.prompt.md

@@ -0,0 +1 @@
+You are a helpful pylint bot. You solve pylint warnings for a specific library. You will be given a GitHub issue link that contains the details of the warnings and the steps to fix them. You will get the github issue body and read the pylint warnings. These are the warnings you want to fix. If you are not sure about a specific warning, leave it as is and do not attempt to fix it. Request the user to provide the issue for the code that needs to be fixed.

.github/workflows/azure-sdk-tools.yml

@@ -7,23 +7,20 @@ on:
     paths:
       - "tools/azure-sdk-tools/**"
 
-
 jobs:
   build-and-test:
     runs-on: ubuntu-latest
     steps:
-      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
       - uses: actions/checkout@v2
 
-      # todo before checkin: multiplex to include running tests on py38 -> 312
       - name: Set up Python 3.11
         uses: actions/setup-python@v4
         with:
           python-version: 3.11
 
       - name: Install azure-sdk-tools
         run: |
-          python -m pip install -e tools/azure-sdk-tools[build,ghtools]
+          python -m pip install -e tools/azure-sdk-tools[build,ghtools,conda]
           python -m pip freeze
         shell: bash
 

.github/workflows/event-processor.yml

@@ -58,7 +58,7 @@ jobs:
         run: >
           dotnet tool install
           Azure.Sdk.Tools.GitHubEventProcessor
-          --version 1.0.0-dev.20240917.2
+          --version 1.0.0-dev.20250314.4
           --add-source https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json
           --global
         shell: bash
@@ -87,17 +87,21 @@ jobs:
 
       - name: Process Action Event
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }}
         shell: bash
         env:
           # This is a temporary secret generated by github
           # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           LABEL_SERVICE_API_KEY: ${{ env.LABEL_SERVICE_API_KEY }}
 
+      - name: Archive github event data
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: event
+          path: ${{ github.event_path }}
+
   event-handler:
     permissions:
       issues: write
@@ -114,7 +118,7 @@ jobs:
         run: >
           dotnet tool install
           Azure.Sdk.Tools.GitHubEventProcessor
-          --version 1.0.0-dev.20240917.2
+          --version 1.0.0-dev.20250314.4
           --add-source https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json
           --global
         shell: bash
@@ -143,12 +147,16 @@ jobs:
 
       - name: Process Action Event
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }}
         shell: bash
         env:
           # This is a temporary secret generated by github
           # https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Archive github event data
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: event
+          path: ${{ github.event_path }}

.github/workflows/post-apiview.yml

@@ -0,0 +1,29 @@
+name: After APIView
+
+on:
+  check_run:
+    types: [completed]
+
+permissions:
+  pull-requests: write
+  contents: read
+
+jobs:
+  post-apiview:
+    name: After APIView
+    runs-on: ubuntu-24.04
+    if: |
+      github.event.check_run.check_suite.app.name == 'Azure Pipelines' && (
+      contains(github.event.check_run.name, 'Build Build') ||
+      contains(github.event.check_run.name, 'Build Analyze') )
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: 'eng/common'
+
+      - name: Create APIView Comment on PR
+        run: |
+          . "eng/common/scripts/Helpers/ApiView-Helpers.ps1"
+          Set-ApiViewCommentForRelatedIssues -HeadCommitish ${{ github.event.check_run.head_sha }} -AuthToken ${{ secrets.GITHUB_TOKEN }}
+        shell: pwsh

.github/workflows/scheduled-event-processor.yml

@@ -39,7 +39,7 @@ jobs:
         run: >
           dotnet tool install
           Azure.Sdk.Tools.GitHubEventProcessor
-          --version 1.0.0-dev.20240917.2
+          --version 1.0.0-dev.20250425.1
           --add-source https://pkgs.dev.azure.com/azure-sdk/public/_packaging/azure-sdk-for-net/nuget/v3/index.json
           --global
         shell: bash
@@ -69,76 +69,62 @@ jobs:
       - name: Close Stale Issues Scheduled Event
         if: github.event.schedule == '0 1 * * *'
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json CloseStaleIssues
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }} CloseStaleIssues
         shell: bash
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Identify Stale PullRequests Scheduled Event
         if: github.event.schedule == '0 5 * * FRI'
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json IdentifyStalePullRequests
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }} IdentifyStalePullRequests
         shell: bash
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Close Stale PullRequests Scheduled Event
         if: github.event.schedule == '30 2,8,14,20 * * *'
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json CloseStalePullRequests
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }} CloseStalePullRequests
         shell: bash
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Identify Stale Issues Scheduled Event
         if: github.event.schedule == '30 3,9,15,21 * * *'
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json IdentifyStaleIssues
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }} IdentifyStaleIssues
         shell: bash
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Close Addressed Issues Scheduled Event
         if: github.event.schedule == '30 4,10,16,22 * * *'
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json CloseAddressedIssues
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }} CloseAddressedIssues
         shell: bash
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Lock Closed Issues Scheduled Event
         if: github.event.schedule == '30 5,11,17,23 * * *'
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json LockClosedIssues
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }} LockClosedIssues
         shell: bash
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Enforce Max Life of Issues Scheduled Event
         if: github.event.schedule == '0 18 * * 1,3,5'
         run: |
-          cat > payload.json << 'EOF'
-          ${{ toJson(github.event) }}
-          EOF
-          github-event-processor ${{ github.event_name }} payload.json EnforceMaxLifeOfIssues
+          github-event-processor ${{ github.event_name }} ${{ github.event_path }} EnforceMaxLifeOfIssues
         shell: bash
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Archive github event data
+        uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: event
+          path: ${{ github.event_path }}