Skip to content

Update linking docs for clarity#805

Merged
trmartin4 merged 5 commits intomainfrom
platform/linking-doc-improvements
Apr 8, 2026
Merged

Update linking docs for clarity#805
trmartin4 merged 5 commits intomainfrom
platform/linking-doc-improvements

Conversation

@trmartin4
Copy link
Copy Markdown
Member

@trmartin4 trmartin4 commented Mar 3, 2026

📔 Objective

Update the linking section of the SDK README to more clearly state the recommended local linking steps, by focusing on the desired client build instead of the code on the client that you're working in.

Link to rendered doc for review: https://github.com/bitwarden/sdk-internal/blob/0ab21c57bb219ad96c00c86c975b8642742be093/README.md#linking

🚨 Breaking Changes

@trmartin4 trmartin4 marked this pull request as ready for review March 3, 2026 02:29
@trmartin4 trmartin4 requested a review from a team as a code owner March 3, 2026 02:29
@trmartin4 trmartin4 requested review from Hinton, addisonbeck and coroiu and removed request for addisonbeck March 3, 2026 02:29
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 3, 2026

Logo
Checkmarx One – Scan Summary & Detailsf1fd2665-64ee-499b-a7b0-53cace8a583a


New Issues (1) Checkmarx found the following issues in this Pull Request
# Severity Issue Source File / Package Checkmarx Insight
1 LOW Parameter_Tampering /crates/bitwarden-uniffi/kotlin/app/src/main/java/com/bitwarden/myapplication/MainActivity.kt: 410
detailsMethod decryptVault at line 410 of /crates/bitwarden-uniffi/kotlin/app/src/main/java/com/bitwarden/myapplication/MainActivity.kt gets user input ...
Attack Vector

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Mar 3, 2026

🔍 SDK Breaking Change Detection Results

SDK Version: platform/linking-doc-improvements (647d25c)
Completed: 2026-04-08 01:51:31 UTC
Total Time: 276s

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

Breaking change detection completed. View SDK workflow

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.39%. Comparing base (12c74b3) to head (647d25c).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #805   +/-   ##
=======================================
  Coverage   82.39%   82.39%           
=======================================
  Files         361      361           
  Lines       43069    43069           
=======================================
  Hits        35488    35488           
  Misses       7581     7581           

☔ 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.

Copy link
Copy Markdown
Member

@Hinton Hinton left a comment

Choose a reason for hiding this comment

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

You also have to build both since otherwise the link will use old type definitions.

Copy link
Copy Markdown
Contributor

@coroiu coroiu left a comment

Choose a reason for hiding this comment

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

Just one comment, otherwise good 👍

Comment thread README.md Outdated
Co-authored-by: Andreas Coroiu <acoroiu@bitwarden.com>
@trmartin4 trmartin4 requested a review from coroiu March 14, 2026 21:32
Copy link
Copy Markdown
Contributor

@coroiu coroiu left a comment

Choose a reason for hiding this comment

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

Sorry, linting issue 🙏

@trmartin4 trmartin4 requested review from Hinton and coroiu April 6, 2026 16:19
@trmartin4 trmartin4 enabled auto-merge (squash) April 6, 2026 16:19
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Apr 8, 2026

@trmartin4 trmartin4 merged commit e4abf50 into main Apr 8, 2026
55 checks passed
@trmartin4 trmartin4 deleted the platform/linking-doc-improvements branch April 8, 2026 06:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants