Skip to content

Commit cb1ed36

Browse files
author
Konrad Jamrozik
authored
Update CONTRIBUTING.md: clarify deployment instructions (#328)
* Update CONTRIBUTING.md: clarify deployment instructions * Update CONTRIBUTING.md * Update CONTRIBUTING.md * Update CONTRIBUTING.md
1 parent 8c3453a commit cb1ed36

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

CONTRIBUTING.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,9 @@ npm list -g oad # Should denote no packages installed
147147
- Verify in [`@azure/oad` versions] the package was published.
148148
- Save it to `openapi-platform` feed via [upstream feeds of `openapi-platform`].
149149
- To make `openapi-alps` use the newly published package:
150-
- Ensure that you update the relevant `package.json` files and then run `rush update` and commit the changes.
150+
- Ensure that you update the minimum package version in relevant `package.json` files and then run `rush update` and commit the changes.
151+
- ❗ 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`.
152+
- 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.
151153
- Example file: [`private/azure-swagger-validation/azureSwaggerValidation/package.json`][azureSwaggerValidation package.json]
152154
- Example `openapi-alps` PR doing the package update: [#537791]
153155
- 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].

0 commit comments

Comments
 (0)