Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[SM-1399] Update the README for Windows on ARM #942

Merged
merged 3 commits into from
Aug 8, 2024
Merged

Conversation

coltonhurst
Copy link
Member

@coltonhurst coltonhurst commented Aug 7, 2024

🎟️ Tracking

https://bitwarden.atlassian.net/browse/SM-1399

📔 Objective

Just cargo build is not sufficient for building the SDK on Windows on ARM. We should add clarity to what is required so that cargo build will run successfully.

Python is required. Clang is also required for ring (more info here).

⏰ 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

Copy link
Contributor

github-actions bot commented Aug 7, 2024

Logo
Checkmarx One – Scan Summary & Detailsff989c72-5b8a-47ef-833c-070a80754409

New Issues

Severity Issue Source File / Package Checkmarx Insight
MEDIUM Privacy_Violation /languages/java/src/main/java/com/bitwarden/sdk/BitwardenClient.java: 41 Attack Vector

Fixed Issues

Severity Issue Source File / Package
MEDIUM Privacy_Violation /languages/java/example/Example.java: 16
MEDIUM Privacy_Violation /languages/java/example/Example.java: 17

Copy link

codecov bot commented Aug 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.45%. Comparing base (b8a024f) to head (941fbae).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #942   +/-   ##
=======================================
  Coverage   58.45%   58.45%           
=======================================
  Files         194      194           
  Lines       13358    13358           
=======================================
  Hits         7808     7808           
  Misses       5550     5550           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@dani-garcia dani-garcia left a comment

Choose a reason for hiding this comment

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

I didn't see the Python requirement in the ring docs, but yeah the clang requirement is true.

Rather than full visual studio I think we can recommend installing the Visual Studio Build Tools which should be somewhat lighter than a full visual studio install. You still need to manually select the clang component and add it to the PATH though.

@coltonhurst
Copy link
Member Author

coltonhurst commented Aug 7, 2024

I didn't see the Python requirement in the ring docs, but yeah the clang requirement is true.

Rather than full visual studio I think we can recommend installing the Visual Studio Build Tools which should be somewhat lighter than a full visual studio install. You still need to manually select the clang component and add it to the PATH though.

Do we know if those build tools include Clang? I attempted this the first time around in my tests and I couldn't find Clang in the filesystem until after I installed the full suite.

I would much rather only recommend Build Tools because it is much smaller as you mentioned.

Edit: And yes, I think Python is required for something else, not ring.

@dani-garcia
Copy link
Member

I think for both the build tools and the full visual studio package you have to manually select clang from the optional packages list inside the Visual Studio Installer, but I haven't checked.

@coltonhurst
Copy link
Member Author

I think for both the build tools and the full visual studio package you have to manually select clang from the optional packages list inside the Visual Studio Installer, but I haven't checked.

This is true for the full setup but I am not given any options for just the build tools.

Screenshot 2024-08-07 at 11 09 52 Screenshot 2024-08-07 at 11 10 10

@coltonhurst coltonhurst requested a review from dani-garcia August 7, 2024 15:36
@dani-garcia
Copy link
Member

I think that's the wrong download, that is the runtime redist and not the build tools, this is what i get with the build tools:
Screenshot 2024-08-07 at 18 46 36
Screenshot 2024-08-07 at 18 50 04

@coltonhurst
Copy link
Member Author

I think that's the wrong download, that is the runtime redist and not the build tools, this is what i get with the build tools: [image]

Ah, I did have the wrong download. Thanks @dani-garcia!

Updated in 941fbae

@coltonhurst coltonhurst merged commit 6e65f97 into main Aug 8, 2024
99 of 103 checks passed
@coltonhurst coltonhurst deleted the sm/sm-1399 branch August 8, 2024 14:02
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.

2 participants