Skip to content

Commit 536e99b

Browse files
committed
Update skill
1 parent 7a3566a commit 536e99b

1 file changed

Lines changed: 17 additions & 5 deletions

File tree

  • sdk/ai/azure-ai-projects/.github/skills/azure-ai-projects-emit-from-typespec

sdk/ai/azure-ai-projects/.github/skills/azure-ai-projects-emit-from-typespec/SKILL.md

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -124,9 +124,12 @@ In the folder `sdk\ai\azure-ai-projects`, run `pip install -e .` to install the
124124

125125
## Step 8: Update CHANGELOG.md
126126

127-
Use the **`azsdk-common-generate-sdk-locally`** skill's changelog capability (`azsdk_package_update_changelog_content`) to update `CHANGELOG.md` in the `sdk/ai/azure-ai-projects` folder with a summary of changes from the TypeSpec emit.
128-
129-
Show the user the proposed changelog entry and ask for confirmation or edits before saving.
127+
Use the **`azsdk-common-generate-sdk-locally`** skill's changelog capability (`azsdk_package_update_changelog_content`) to update `CHANGELOG.md` in the `sdk/ai/azure-ai-projects` folder with a summary of changes from the TypeSpec emit. Some guidelines to follow:
128+
* Start by examining the public SDK API surface of the latest released version of the azure-ai-projects package. The source code for this version can be found in the Main branch of the `azure-sdk-for-python` repository, in the folder `sdk\ai\azure-ai-projects`.
129+
* Then compare it to the public SDK API surface of current version in this topic branch.
130+
* Look at the existing change log from the latest version (if exists) and edit or add to it to capture all the changes you see. If a change log does not exist for the current version at the top of `CHANGELOG.md`, create a new one.
131+
* If a new method was added, there is no need to add the list of all new classes that define the inputs and output of the method. It's enough to mention that the new method was added.
132+
* Show the user the proposed changelog entry and ask for confirmation or edits before saving.
130133

131134
---
132135

@@ -169,6 +172,15 @@ Show the user the PR URL when done.
169172

170173
Prompt the user with this message: "Tests will run as part of the Pull Request. However, you can optionally run tests locally right now. It will take a few minutes. Do you want to run tests locally now? (yes/no)"
171174

172-
If the user answers "yes", run all tests.
175+
If the user answers "yes", run all tests from recordings. Follow these guidelines:
176+
* Run tests in a local Python virtual environment. Create this virtual environment if it does not already exists:
177+
```
178+
python -m venv .venv
179+
```
180+
and activate it:
181+
```
182+
.venv\Scripts\activate
183+
```
184+
* Show test progress on screen, as tests are run.
185+
173186

174-
```

0 commit comments

Comments
 (0)