[PM-31468] Consolidated build and link instructions#718
Conversation
🔍 SDK Breaking Change Detection ResultsSDK Version:
Breaking change detection completed. View SDK workflow |
|
Great job! No new security vulnerabilities introduced in this pull request |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #718 +/- ##
==========================================
- Coverage 80.05% 79.99% -0.07%
==========================================
Files 306 308 +2
Lines 33695 33810 +115
==========================================
+ Hits 26976 27046 +70
- Misses 6719 6764 +45 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
README.md
Outdated
| Keep in mind that running `npm link` will restore any previously linked packages, so only the paths | ||
| in the last run command will be linked. |
There was a problem hiding this comment.
suggestion: I think we should add a tip that if you want to bind multiple packages (e.g. if you are building OSS and Commercial code) you can just run npm link with both paths in the command (in fact, it's the only way to bind both at the same time since, like you say, everything else is restored)

🎟️ Tracking
https://bitwarden.atlassian.net/browse/PM-31468
📔 Objective
Consolidates instructions for how to build and consume
sdk-internalinto theREADME, instead of between theREADMEand Contributing Docs.Adds documentation of how to update published artifacts on
clients,ios, andandroidrepositories, to aid in understanding of how to integratesdk-internalchanges into the SDLC.Corresponding PR to clean up Contributing Docs: bitwarden/contributing-docs#757
🚨 Breaking Changes
⏰ Reminders before review
team
🦮 Reviewer guidelines
:+1:) or similar for great changes:memo:) or ℹ️ (:information_source:) for notes or general info:question:) for questions:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmedissue and could potentially benefit from discussion
:art:) for suggestions / improvements:x:) or:warning:) for more significant problems or concerns needing attention:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt:pick:) for minor or nitpick changes