From 42e29a7247337723085902798d44805a1efa2ab6 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 9 Sep 2025 18:56:27 -0700 Subject: [PATCH 1/5] [CONTRIBUTING.md] Update from openapi-alps to specs --- CONTRIBUTING.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 261b4696..49a03982 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -144,18 +144,8 @@ npm list -g oad # Should denote no packages installed - Ensure you bumped the package version in [`openapi-diff`] `package.json`. - Queue a run of the [`openapi-diff` pipeline] and approve the `publish` stage. (Note: there is also the [`public.openapi-diff` pipeline] for CI checks.) - Verify in [`@azure/oad` versions] that the newest package version was published on npmjs.org. You can also run `npm show @azure/oad`. -- Save it to `openapi-platform` feed via [upstream feeds of `openapi-platform`]. - - For the desired version, you must click `Save to feed` in the context menu of the hidden triple-dot button on the right. It will reveal on hover. - - You may need to wait a bit until the newest version shows up in the `Upstream Versions` tab. -- To make `openapi-alps` use the newly published package: - - Ensure that you update the minimum package version in relevant [`package.json`][azureSwaggerValidation package.json] files and then run `rush update` and commit the changes. - - ❗ Do the update even if semver rules say the new package version is in scope. E.g. if the version is `~0.10.7` but you published `0.10.8`, then still update the entry to `~0.10.8`. - - If you will not modify any `package.json` at all, rush will not recognize the newly published package version. This can be worked around by running `rush update --full`, but this is discouraged. - - Example file: [`private/azure-swagger-validation/azureSwaggerValidation/package.json`][azureSwaggerValidation package.json]. - - Example `openapi-alps` PR doing the package update: [#537791]. -- Redeploy relevant `openapi-alps` parts to pick up the new package, even if you didn't had to commit any changes. Follow [this doc][openapi-alps doc]. - -[#537791]: https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/pullrequest/537791 +- Create a PR to [`azure-rest-api-specs`], updating all references to `@azure/oad` in `package[-lock].json` + [`@azure/oad` versions]: https://www.npmjs.com/package/@azure/oad?activeTab=versions [`dotnet build`]: https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build [`dotnet restore`]: https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-restore @@ -163,6 +153,7 @@ npm list -g oad # Should denote no packages installed [`npm link`]: https://docs.npmjs.com/cli/v10/commands/npm-link [`openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/internal/_build/index?definitionId=7030 [`openapi-diff`]: https://github.com/Azure/openapi-diff +[`azure-rest-api-specs`]: https://github.com/Azure/azure-rest-api-specs [`public.openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/public/_build?definitionId=135&_a=summary [azureSwaggerValidation package.json]: https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps?path=/private/azure-swagger-validation/azureSwaggerValidation/package.json&version=GC78491f959bc714d1a0d35060e58fa6c5888bb828&line=44&lineEnd=44&lineStartColumn=7&lineEndColumn=16&lineStyle=plain&_a=contents [openapi-alps doc]: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/891/openapi-alps?anchor=testing-and-deploying-changes From 23a8851808b9c4f795fdcec9278e933a9b084c09 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 9 Sep 2025 18:57:59 -0700 Subject: [PATCH 2/5] remove openapi-alps doc link --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 49a03982..fdfa3b0f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -156,7 +156,6 @@ npm list -g oad # Should denote no packages installed [`azure-rest-api-specs`]: https://github.com/Azure/azure-rest-api-specs [`public.openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/public/_build?definitionId=135&_a=summary [azureSwaggerValidation package.json]: https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps?path=/private/azure-swagger-validation/azureSwaggerValidation/package.json&version=GC78491f959bc714d1a0d35060e58fa6c5888bb828&line=44&lineEnd=44&lineStartColumn=7&lineEndColumn=16&lineStyle=plain&_a=contents -[openapi-alps doc]: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/891/openapi-alps?anchor=testing-and-deploying-changes [the cache]: https://docs.npmjs.com/cli/v10/configuring-npm/folders#cache [upstream feeds of `openapi-platform`]: https://devdiv.visualstudio.com/DevDiv/_artifacts/feed/openapi-platform/Npm/@azure%2Foad/upstreams/ From 461fc8c9ab0b3c8361b74a760a77fcf212be3e57 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 9 Sep 2025 18:59:00 -0700 Subject: [PATCH 3/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fdfa3b0f..dc377571 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -157,6 +157,5 @@ npm list -g oad # Should denote no packages installed [`public.openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/public/_build?definitionId=135&_a=summary [azureSwaggerValidation package.json]: https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps?path=/private/azure-swagger-validation/azureSwaggerValidation/package.json&version=GC78491f959bc714d1a0d35060e58fa6c5888bb828&line=44&lineEnd=44&lineStartColumn=7&lineEndColumn=16&lineStyle=plain&_a=contents [the cache]: https://docs.npmjs.com/cli/v10/configuring-npm/folders#cache -[upstream feeds of `openapi-platform`]: https://devdiv.visualstudio.com/DevDiv/_artifacts/feed/openapi-platform/Npm/@azure%2Foad/upstreams/ From 37bbf788dcc6f3d86512ff05c30f0112bd862568 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 9 Sep 2025 19:01:26 -0700 Subject: [PATCH 4/5] Update CONTRIBUTING.md --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dc377571..a058a8b2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -155,7 +155,6 @@ npm list -g oad # Should denote no packages installed [`openapi-diff`]: https://github.com/Azure/openapi-diff [`azure-rest-api-specs`]: https://github.com/Azure/azure-rest-api-specs [`public.openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/public/_build?definitionId=135&_a=summary -[azureSwaggerValidation package.json]: https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps?path=/private/azure-swagger-validation/azureSwaggerValidation/package.json&version=GC78491f959bc714d1a0d35060e58fa6c5888bb828&line=44&lineEnd=44&lineStartColumn=7&lineEndColumn=16&lineStyle=plain&_a=contents [the cache]: https://docs.npmjs.com/cli/v10/configuring-npm/folders#cache From 1d44ace6eacf4b661b4a97df8647102bd3f8f1d0 Mon Sep 17 00:00:00 2001 From: Mike Harder Date: Tue, 9 Sep 2025 19:02:36 -0700 Subject: [PATCH 5/5] Fix link formatting for azure-rest-api-specs --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a058a8b2..35e855d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -153,8 +153,6 @@ npm list -g oad # Should denote no packages installed [`npm link`]: https://docs.npmjs.com/cli/v10/commands/npm-link [`openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/internal/_build/index?definitionId=7030 [`openapi-diff`]: https://github.com/Azure/openapi-diff -[`azure-rest-api-specs`]: https://github.com/Azure/azure-rest-api-specs [`public.openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/public/_build?definitionId=135&_a=summary [the cache]: https://docs.npmjs.com/cli/v10/configuring-npm/folders#cache - - +[`azure-rest-api-specs`]: https://github.com/Azure/azure-rest-api-specs