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
Update local SDK workflow instructions with commit checkpoints
Add commit checkpoint steps (Step 3 and Step 7) to prompt users to commit
generated and final changes during the local SDK workflow. Reorder steps
and clarify the high-level overview presentation as a MUST action.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
**Goal**: Prompt the user to commit the changes produced by the generation and build steps before proceeding to validation and testing.
144
+
**Actions**:
145
+
146
+
-**MUST** inform the user that SDK generation and build have completed successfully.
147
+
-**MUST** prompt the user to decide if they want to commit the changes now. Do NOT skip this prompt.
148
+
- If the user chooses to commit:
149
+
- Check if the user is on the `main` branch. If so, prompt: *"You are currently on the main branch. Please create a new branch using `git checkout -b <branch-name>` before proceeding."* Suggest a reasonable default branch name based on the generation context (e.g., `sdk/<service-name>/<package-name>`) and provide the exact `git checkout -b <branch-name>` command for the user to run. Allow the user to provide a preferred branch name instead. Wait for user confirmation before continuing.
150
+
- Run `git add <modified-files>` to stage the changed files.
151
+
- Prompt the user for a commit message.
152
+
- Run `git commit -m "<user-provided-message>"`.
153
+
- If the user chooses to skip, acknowledge and proceed to the next step.
154
+
155
+
---
156
+
157
+
### Step 4: Run package validation
136
158
137
159
**Actions**:
138
160
139
161
- Run `azsdk_package_run_check` MCP tool to validate the generated SDK package in the identified project directory.
140
162
141
163
---
142
164
143
-
### Step 4: Run package tests
165
+
### Step 5: Run package tests
144
166
145
167
**Actions**:
146
168
147
169
- Run `azsdk_package_run_tests` MCP tool to run tests on the generated SDK package in the identified project directory.
148
170
149
171
---
150
172
151
-
### Step 5: Update change log, metadata and version
173
+
### Step 6: Update change log, metadata and version
152
174
153
175
**Actions**:
154
176
155
-
- Run `azsdk_package_update_metadata` MCP tool to update metadata in the identified project directory.
156
177
- Run `azsdk_package_update_changelog_content` MCP tool to update change log in the identified project directory.
157
-
- Run `azsdk_package_update_version` MCP tool to update version in the identified project directory.
178
+
- Run `azsdk_package_update_metadata` MCP tool to update metadata in the identified project directory.
179
+
- Run `azsdk_package_update_version` MCP tool to update version in the identified project directory.
180
+
181
+
---
182
+
183
+
### Step 7: Stage checkpoint — Commit final changes
184
+
185
+
**Goal**: Prompt the user to commit the final set of changes after all updates are complete.
186
+
**Actions**:
187
+
188
+
-**MUST** inform the user that changelog, metadata, and version updates are complete.
189
+
-**MUST** prompt the user to decide if they want to commit the changes now. Do NOT skip this prompt.
190
+
- If the user chooses to commit:
191
+
- Check if the user is on the `main` branch. If so, prompt: *"You are currently on the main branch. Please create a new branch using `git checkout -b <branch-name>` before proceeding."* Suggest a reasonable default branch name based on the generation context (e.g., `sdk/<service-name>/<package-name>`) and provide the exact `git checkout -b <branch-name>` command for the user to run. Allow the user to provide a preferred branch name instead. Wait for user confirmation before continuing.
192
+
- Run `git add <modified-files>` to stage the changed files.
193
+
- Prompt the user for a commit message.
194
+
- Run `git commit -m "<user-provided-message>"`.
195
+
- If the user chooses to skip, acknowledge and proceed.
0 commit comments