Skip to content

Update Batch SDK regeneration instructions #12347

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
isra-fel merged 1 commit into from
Jun 2, 2020
Merged

Update Batch SDK regeneration instructions #12347

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions sdk/batch/Microsoft.Azure.Management.Batch/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
* Add new APIs as path-verb pairs in the Swagger specification.
* Add/remove properties on existing entity types in the Swagger specification.
2. Regenerate the SDK based using [AutoRest](https://github.com/Azure/autorest) on the updated Swagger specification:
* `Start-AutoRestCodeGeneration -SdkRepoRootPath <path to this repo root> -ResourceProvider "batch/resource-manager" -AutoRestVersion "latest" -SdkGenerationDirectory "<path to this repo root>\sdk\batch\Microsoft.Azure.Management.Batch\src\generated" -ConfigFileTag "package-2020-03"`
* See this document for more information: https://github.com/Azure/adx-documentation-pr/blob/master/engineering/adx_netsdk_process.md#sdk-generation-from-updated-spec
* Run the command from the root of the repo: `sdk/batch/Microsoft.Azure.Management.Batch/src/generate.ps1`
3. Add new tests for your new models and APIs. There are two types of tests, "recorded" tests and unit tests:
* Recorded tests are run live and the request/response payloads are recorded and then replayed for subsequent runs.
* Unit tests are in-memory tests which never actually make a REST call.
* **Note:** You should prefer to add unit tests over recording tests where possible -- recording tests should be reserved for ensuring that the Batch Service accepts the Swagger payload, and only cover the basic happy path scenarios.
4. Update the `CHANGELOG.md` file and the `Version` tag in `src/Microsoft.Azure.Management.Batch.csproj`. Ensure that if you are making a breaking change, you update the major version of the version number.
5. Re-record all of the recording tests against the new API version (see [here](https://github.com/Azure/azure-sdk-for-net/blob/master/doc/dev/Using-Azure-TestFramework.md) for details on how to use the recording framework).
6. Switch test mode back to `Playback` and ensure that all of the tests pass.
7. Open a PR to https://github.com/Azure/azure-sdk-for-net.
7. Open a PR to https://github.com/Azure/azure-sdk-for-net.