You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
## Step 8: Fix patched code related to preview feature headers
109
137
110
138
The emitted code may have introduced another beta sub-client (a new property on class `BetaOperations`). It may have also added another enum value to the existing internal class `_FoundryFeaturesOptInKeys`. This means that the client library needs to set a new HTTP request header when making REST API calls to the service, to opt-in to the new service features which are still in preview. If that's the case, do the following:
111
139
@@ -117,9 +145,11 @@ The emitted code may have introduced another beta sub-client (a new property on
117
145
118
146
If a new enum value was added to `_AgentDefinitionOptInKeys`, please print a note on screen that mentions which value was added, and tell the user that a review is needed to make sure this new value is properly used. But otherwise continue on.
119
147
148
+
Important: Under the `azure\ai\projects` folder, you are only allowed to edit Python source files that start with "_patch". If you see that changes are needed in other files, stop and report this to the user instead of making the changes yourself.
149
+
120
150
---
121
151
122
-
## Step 7: Update samples and tests
152
+
## Step 9: Update samples and tests
123
153
124
154
If there were any breaking changes in existing APIs, like class or method renames:
125
155
* update the patched code accordingly in the client library to reflect those changes. Changes should be made to Python source file names that start with "_patch", under the `azure\ai\projects` folder.
@@ -128,13 +158,13 @@ If there were any breaking changes in existing APIs, like class or method rename
128
158
129
159
---
130
160
131
-
## Step 8: Install package from sources
161
+
## Step 10: Install package from sources
132
162
133
163
In the folder `sdk\ai\azure-ai-projects`, run `pip install -e .` to install the package from sources. If there are any errors, stop and report the error to the user. Do not continue.
134
164
135
165
---
136
166
137
-
## Step 9: Update CHANGELOG.md
167
+
## Step 11: Update CHANGELOG.md
138
168
139
169
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:
140
170
* 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`.
@@ -145,21 +175,21 @@ Use the **`azsdk-common-generate-sdk-locally`** skill's changelog capability (`a
145
175
146
176
---
147
177
148
-
## Step 10: Commit and push
178
+
## Step 12: Commit and push
149
179
150
180
Stage all changes (excluding file names that start with `.env`), commit, and push the topic branch:
151
181
152
182
```
153
183
git add -A -- ':!.env*'
154
-
git commit -m "Emit SDK from TypeSpec and apply post-emitter fixes
Create a draft PR from the **topic branch** to the **base branch** (recorded in Step 2):
165
195
@@ -176,7 +206,7 @@ Open a new tab in the default browser and navigate to the PR URL.
176
206
177
207
---
178
208
179
-
## Step 12: Optionally run tests locally
209
+
## Step 14: Optionally run tests locally
180
210
181
211
Prompt the user with this message: "Tests will run as part of the Pull Request. However, you can optionally run tests locally in a Python virtual environment, right now. It will take a few minutes. Do you want to run tests locally? (yes/no)"
0 commit comments