From 4293d23f12b2d4fade4f9d62271bd776466b42e7 Mon Sep 17 00:00:00 2001 From: iscai-msft <43154838+iscai-msft@users.noreply.github.com> Date: Wed, 8 Jan 2025 16:21:51 -0500 Subject: [PATCH] [python] update contributing (#5540) Co-authored-by: iscai-msft --- packages/http-client-python/CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/packages/http-client-python/CONTRIBUTING.md b/packages/http-client-python/CONTRIBUTING.md index 88a22ceede..55f1226784 100644 --- a/packages/http-client-python/CONTRIBUTING.md +++ b/packages/http-client-python/CONTRIBUTING.md @@ -4,7 +4,7 @@ To observe the downstream effects of changes in this `@typespec/http-client-python` package on `@azure-tools/typespec-python`, we require a green PR to the [autorest.python](https://github.com/Azure/autorest.python) repo to ensure this. -To make the downstream PR, follow these steps: +The creation of this downstream PR is semi-automatic 1. Create your intended PR to the [microsoft/typespec](https://github.com/microsoft/typespec) repo for `@typespec/http-client-python` 2. After the above CI passes, you get the url of a private package in CI. @@ -12,7 +12,10 @@ To make the downstream PR, follow these steps: a. Click on the section that says `5 published; 1 consumed`, like in the above picture b. Follow `Published artifacts -> build_artifacts_python -> packages -> typespec-http-client-python-x.x.x.tgz`. c. Go to the right side, click the three dots, and click `Copy download url`. -3. Create a _draft_ PR in [autorest.python](https://github.com/Azure/autorest.python), updating the version of the `@typespec/http-client-python` in the `package.json` files to be the downloaded URL -4. Run `pnpm install`, and follow that repo's [CONTRIBUTING.md](https://github.com/Azure/autorest.python/blob/main/CONTRIBUTING.md) for your second PR +3. Run [this](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=4278466&view=results) pipeline with the following variables + a. `PULL-REQUEST-URL` equaling the url of the PR created in step 1 + b. `ARTIFACTS-URL` equaling the url you get in step 2 +4. Step 3 will create a PR in [autorest.python](https://github.com/Azure/autorest.python). If you need to make any changes to code in the autorest.python repo, follow that repo's [CONTRIBUTING.md](https://github.com/Azure/autorest.python/blob/main/CONTRIBUTING.md) 5. Once the PR to [autorest.python](https://github.com/Azure/autorest.python) passes, you can merge and release the original PR -6. When the change to `@typespec/http-client-python` has been released, update your [autorest.python](https://github.com/Azure/autorest.python) repo to use the released version of the `@typespec/http-client-python` package + +When the change to `@typespec/http-client-python` has been released, update your [autorest.python](https://github.com/Azure/autorest.python) repo to use the released version of the `@typespec/http-client-python` package. You will need to run `pnpm install` to make sure the dependency map is correctly set up. You are now able to release the autorest emitters with your original change.