Skip to content

Commit 9ecf8d7

Browse files
author
Konrad Jamrozik
authored
Update CONTRIBUTING.md: publication instructions (#342)
1 parent bc910ec commit 9ecf8d7

File tree

1 file changed

+20
-16
lines changed

1 file changed

+20
-16
lines changed

CONTRIBUTING.md

+20-16
Original file line numberDiff line numberDiff line change
@@ -142,27 +142,31 @@ npm list -g oad # Should denote no packages installed
142142
## Publish the package
143143

144144
- Ensure you bumped the package version in [`openapi-diff`] `package.json`.
145-
- Queue a run of the [`openapi-diff-build`] and approve the 'publish' stage.
146-
- Verify in [`@azure/oad` versions] the package was published on npmjs.org.
145+
- 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.)
146+
- Verify in [`@azure/oad` versions] that the newest package version was published on npmjs.org. You can also run `npm show @azure/oad`.
147147
- Save it to `openapi-platform` feed via [upstream feeds of `openapi-platform`].
148+
- 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.
149+
- You may need to wait a bit until the newest version shows up in the `Upstream Versions` tab.
148150
- To make `openapi-alps` use the newly published package:
149-
- Ensure that you update the minimum package version in relevant `package.json` files and then run `rush update` and commit the changes.
150-
- ❗ 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`.
151-
- 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.
152-
- Example file: [`private/azure-swagger-validation/azureSwaggerValidation/package.json`][azureSwaggerValidation package.json]
153-
- Example `openapi-alps` PR doing the package update: [#537791]
154-
- 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].
151+
- 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.
152+
- ❗ 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`.
153+
- 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.
154+
- Example file: [`private/azure-swagger-validation/azureSwaggerValidation/package.json`][azureSwaggerValidation package.json].
155+
- Example `openapi-alps` PR doing the package update: [#537791].
156+
- 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].
155157

156-
[`openapi-diff`]: https://github.com/Azure/openapi-diff
157-
[`dotnet restore`]: https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-restore
158+
[#537791]: https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/pullrequest/537791
159+
[`@azure/oad` versions]: https://www.npmjs.com/package/@azure/oad?activeTab=versions
158160
[`dotnet build`]: https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-build
161+
[`dotnet restore`]: https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-restore
159162
[`dotnet test`]: https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-test
160163
[`npm link`]: https://docs.npmjs.com/cli/v10/commands/npm-link
164+
[`openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/internal/_build/index?definitionId=7030
165+
[`openapi-diff`]: https://github.com/Azure/openapi-diff
166+
[`public.openapi-diff` pipeline]: https://dev.azure.com/azure-sdk/public/_build?definitionId=135&_a=summary
167+
[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
168+
[openapi-alps doc]: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/891/openapi-alps?anchor=testing-and-deploying-changes
161169
[the cache]: https://docs.npmjs.com/cli/v10/configuring-npm/folders#cache
162-
[`openapi-diff-build`]: https://dev.azure.com/azure-sdk/internal/_build/index?definitionId=7030
163-
[`public.openapi-diff`]: https://dev.azure.com/azure-sdk/public/_build?definitionId=135&_a=summary
164170
[upstream feeds of `openapi-platform`]: https://devdiv.visualstudio.com/DevDiv/_artifacts/feed/openapi-platform/Npm/@azure%2Foad/upstreams/
165-
[`@azure/oad` versions]: https://www.npmjs.com/package/@azure/oad?activeTab=versions
166-
[openapi-alps doc]: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/891/openapi-alps?anchor=testing-and-deploying-changes
167-
[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
168-
[#537791]: https://devdiv.visualstudio.com/DevDiv/_git/openapi-alps/pullrequest/537791
171+
172+

0 commit comments

Comments
 (0)