Skip to content

[PM-31468] Consolidated build and link instructions#718

Merged
trmartin4 merged 22 commits intomainfrom
consolidate-build-link-instructions
Feb 5, 2026
Merged

[PM-31468] Consolidated build and link instructions#718
trmartin4 merged 22 commits intomainfrom
consolidate-build-link-instructions

Conversation

@trmartin4
Copy link
Member

@trmartin4 trmartin4 commented Jan 28, 2026

🎟️ Tracking

https://bitwarden.atlassian.net/browse/PM-31468

📔 Objective

Consolidates instructions for how to build and consume sdk-internal into the README, instead of between the README and Contributing Docs.

Adds documentation of how to update published artifacts on clients, ios, and android repositories, to aid in understanding of how to integrate sdk-internal changes into the SDLC.

Corresponding PR to clean up Contributing Docs: bitwarden/contributing-docs#757

🚨 Breaking Changes

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation
    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 confirmed
    issue 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

@trmartin4 trmartin4 changed the title Consolidated instructions Consolidated build and link instructions Jan 28, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Jan 28, 2026

🔍 SDK Breaking Change Detection Results

SDK Version: consolidate-build-link-instructions (a4be876)
Completed: 2026-02-04 22:12:43 UTC
Total Time: 249s

Client Status Details
typescript ✅ No breaking changes detected TypeScript compilation passed with new SDK version - View Details

Breaking change detection completed. View SDK workflow

@github-actions
Copy link
Contributor

github-actions bot commented Jan 28, 2026

Logo
Checkmarx One – Scan Summary & Detailsd2743447-3472-4668-9579-47bec7ca16c6

Great job! No new security vulnerabilities introduced in this pull request

@codecov
Copy link

codecov bot commented Jan 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.99%. Comparing base (5285d3f) to head (a4be876).
⚠️ Report is 13 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@trmartin4 trmartin4 marked this pull request as ready for review January 30, 2026 18:17
@trmartin4 trmartin4 requested a review from a team as a code owner January 30, 2026 18:17
@trmartin4 trmartin4 requested a review from coroiu January 30, 2026 18:17
@trmartin4 trmartin4 changed the title Consolidated build and link instructions [PM-31468] Consolidated build and link instructions Jan 30, 2026
@trmartin4 trmartin4 marked this pull request as draft January 30, 2026 18:25
@trmartin4 trmartin4 marked this pull request as ready for review January 30, 2026 23:18
README.md Outdated
Comment on lines 117 to 118
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in a4be876 (this PR).

@trmartin4 trmartin4 requested a review from coroiu February 4, 2026 22:01
@trmartin4 trmartin4 added the ai-review Request a Claude code review label Feb 4, 2026
@trmartin4 trmartin4 merged commit b65c48c into main Feb 5, 2026
65 checks passed
@trmartin4 trmartin4 deleted the consolidate-build-link-instructions branch February 5, 2026 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-review Request a Claude code review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants