-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
57 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Maintain code snippets in Azure docs | ||
|
||
You can perform all maintenance tasks in Codespaces, with no additional setup needed. Click the button below to open this repo in a Codespace. | ||
|
||
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/sdgilley/learn-tools?quickstart=1) | ||
|
||
|
||
## Daily tasks | ||
|
||
1. Check for [PRs that need approval](https://github.com/Azure/azureml-examples/pulls?q=is%3Apr+is%3Aopen+user-review-requested%3A%40me ) | ||
|
||
1. For each PR number that you need to investigate, in the terminal, run: | ||
|
||
```bash | ||
./pr.sh <pr-number> | ||
``` | ||
|
||
1. Approve if no issues reported. | ||
1. If issues are present, see [Fix the Problem](https://microsoft.sharepoint.com/teams/AzureDataandAIDocsLT/_layouts/OneNote.aspx?id=%2Fteams%2FAzureDataandAIDocsLT%2FShared%20Documents%2FGeneral%2FAdvanced%20Analytics%20Tech%20Docs&wd=target%28Code%20Maintenance.one%7C2EEC86EA-36BC-4D03-A0EE-4684419BF75B%2FFix%20the%20Problem%7CF06C94CC-934D-4E05-B461-5BB56ECBE65E%2F%29) | ||
|
||
## Weekly tasks | ||
|
||
### Update snippet references and codeowners files | ||
|
||
1. Run this script (takes about two minutes): | ||
|
||
```bash | ||
python GitHub/find-snippets.py | ||
``` | ||
|
||
1. If changes to .txt and .csv files appear, commit them to this repo (learn-tools). You can do this from a Codespace, but you'll first need to switch to a new branch. | ||
1. If changes to CODEOWNERS appear, commit them to azureml-examples [CODEOWNERS](https://github.com/Azure/azureml-examples/blob/main/.github/CODEOWNERS) file | ||
### Update docs | ||
1. Run the merge report. If last run 7 days ago, simply run: | ||
```bash | ||
./merge.sh | ||
``` | ||
1. If longer than 7 days since last run: | ||
```bash | ||
./merge.sh <days> | ||
``` | ||
1. Modify the files in azure-docs-pr as listed in the report. |