Skip to content

Add PQ-TLS macOS/Windows compatibility note to README#196

Merged
simonmarty merged 1 commit intoaws:v2from
vedant-jaiswal:pqtls-readme
Apr 14, 2026
Merged

Add PQ-TLS macOS/Windows compatibility note to README#196
simonmarty merged 1 commit intoaws:v2from
vedant-jaiswal:pqtls-readme

Conversation

@vedant-jaiswal
Copy link
Copy Markdown
Contributor

Description

Why is this change being made?

  1. Users attempting to use PQ-TLS on macOS or Windows may encounter unexpected behavior due to AWS CRT system library dependencies. This note proactively informs users of the known limitation.

What is changing?

    1. Added a note in the "Enabling Post-Quantum TLS" section of the README warning that PQ-TLS may not work as expected on macOS or Windows due to AWS CRT system library dependencies, with a reference link.

Related Links

  • Issue #, if available:

Testing

How was this tested?

  1. Documentation-only change

When testing locally, provide testing artifact(s):

  1. Verified README renders correctly using VS Code Markdown preview.

Reviewee Checklist

Update the checklist after submitting the PR

  • I have reviewed, tested and understand all changes
    If not, why:
  • I have filled out the Description and Testing sections above
    If not, why:
  • Build and Unit tests are passing
    If not, why:
  • Unit test coverage check is passing
    If not, why:
  • I have ensured no sensitive information is leaking (i.e., no logging of sensitive fields, or otherwise)
    If not, why:
  • I have added explanatory comments for complex logic, new classes/methods and new tests
    If not, why:
  • I have updated README/documentation (if needed)
    If not, why:
  • I have clearly called out breaking changes (if any)
    If not, why:

Reviewer Checklist

All reviewers please ensure the following are true before reviewing:

  • Reviewee checklist has been accurately filled out
  • Code changes align with stated purpose in description
  • Test coverage adequately validates the changes

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@vedant-jaiswal vedant-jaiswal requested a review from a team as a code owner April 13, 2026 23:24
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 13, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.83%. Comparing base (4bc213f) to head (bde9262).
⚠️ Report is 1 commits behind head on v2.

Additional details and impacted files
@@            Coverage Diff            @@
##                 v2     #196   +/-   ##
=========================================
  Coverage     91.83%   91.83%           
  Complexity       97       97           
=========================================
  Files             6        6           
  Lines           245      245           
  Branches         26       26           
=========================================
  Hits            225      225           
  Misses           18       18           
  Partials          2        2           

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

@simonmarty simonmarty merged commit dc47d68 into aws:v2 Apr 14, 2026
5 checks passed
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