README.md

GitHub scripts

See Maintain code snippets in Azure docs for more information on how to use these scripts.

Scripts in this folder are used to help us maintain our code references.

If running locally instead of Codespaces, make sure you have pyGithub installed (pip install pyGithub) to run these scripts

• find-snippets.py - use arguments (ai, ml, all) to specify which repo. If no arguments, defaults to ml.

  • creates the file refs-found.csv. This file is used for both the pr-report and merge-report scripts.
  • create a CODEOWNERS file for the azureml-examples repo. Use this to generate content to replace the lines in https://github.com/Azure/azureml-examples/blob/main/.github/CODEOWNERS.
  • Examples:
    • python find-snippets.py ai to find all code snippets in the azureai-samples repo.
    • python find-snippets.py ml to find all code snippets in the azureml-examples repo.
    • python find-snippets.py all to find all code snippets in both repos.

• pr-report.py - add argument ai to use for azureai-samples instead of azureml-examples. Use this to evaluate whether a PR in azureml-examples/azureai-samples will cause problems in our docs build. If you're using it for the first time in a while, first run find-sippets.py to get the most recent version of code snippets referenced by azure-ai-docs.

  • Examples:
    • python pr-report.py 91 to check PR 91 in azureml-examples repo.
    • python pr-report.py 91 ai to check PR 91 in azureai-samples repo.

• pr-check.py - ML ONLY FOR NOW shortened version of pr-report.py. Checks for files that are in azureml-examples repo CODEOWNERS to see if they have been deleted, or if ids/names in a file have been removed. Alerts if there is a problem. Could be adapted for use in a GitHub action to check PRs before they are merged. (Does not use any local files, only the CODEOWNERS file from the azureml-examples repo.)

• merge-report.py - - use arguments (ai, ml, all) to speciy which repo. If no arguments, defaults to ml. Use this to see what PRs in azureml-examples have merged in the last N days that might require a docs update (default is 8 days). If you're using it for the first time in a while, first runfind-sippets.py to get the most recent version of code snippets referenced by azure-ai-docs.

  • Examples:
    • python merge-report.py to check the azureml-examples repo.
    • python merge-report.py ai to check the azureai-samples repo.
    • python merge-report.py all to check both repos.

The following files provide functions used in the above scripts:

• utilities.py - functions used by find-snippets, pr-report, and merge-report

• auth_request.py - function used by pr-report and merge-report to authenticate to github.

  You'll need to set a GH_ACCESS_TOKEN environment variable before using auth_-_request.py. See https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens to create a token. Then add the token to an environment variable called GH_ACCESS_TOKEN.