Skip to content

Overhaul: Bump elixir implementation and add comprehensive code coverage. #67

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

Open
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

Hydepwns
Copy link

  • Expanded @moduledoc for WorkOS.Organizations with a clear overview and comprehensive usage examples. - Clarified docstrings for function parameters. - No functional changes.

Hydepwns added 16 commits May 14, 2025 17:09
…les - Expanded @moduledoc for WorkOS.Organizations with a clear overview and comprehensive usage examples. - Clarified docstrings for function parameters. - No functional changes.
…ameter validation - Added tests for API error responses, missing required parameters, and empty list handling in WorkOS.Organizations. - Updated create_organization and update_organization to return {:error, :missing_name} if :name is missing, instead of raising. - Improves robustness and user experience for the Organizations API.
@Hydepwns
Copy link
Author

Got to >90% code coverage. I'm interested in bumping to support OTP 27 but a bit constrained on time/resources -- @marktran or @nholden thoughts?

Updating title of pr to be more accurate

@Hydepwns Hydepwns changed the title Organization(documentation): improve module docs + add usage examples Overhaul: Bump elixir implementation and add comprehensive code coverage. May 15, 2025
@marktran marktran requested a review from Copilot May 15, 2025 18:01
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This pull request overhauls the Elixir SDK documentation and CI workflow configurations with expanded module documentation and improved code coverage reporting.

  • Added a Codecov badge to README.md for enhanced visibility of test coverage.
  • Updated CI workflow: switched branch reference from master to main, bumped the Ubuntu runner version, and integrated new Codecov actions for uploading test results and coverage reports.

Reviewed Changes

Copilot reviewed 20 out of 38 changed files in this pull request and generated no comments.

File Description
README.md Added a Codecov badge and removed a stray header line.
.github/workflows/main.yml Updated CI configurations including Ubuntu version bump and Codecov upload steps.
Files not reviewed (18)
  • lib/workos/castable.ex: Language not supported
  • lib/workos/client.ex: Language not supported
  • lib/workos/organizations.ex: Language not supported
  • lib/workos/sso.ex: Language not supported
  • lib/workos/user_management/multi_factor/sms.ex: Language not supported
  • lib/workos/user_management/multi_factor/totp.ex: Language not supported
  • lib/workos/user_management/organization_membership.ex: Language not supported
  • lib/workos/user_management/reset_password.ex: Language not supported
  • lib/workos/user_management/user.ex: Language not supported
  • mix.exs: Language not supported
  • test/support/audit_logs_client_mock.ex: Language not supported
  • test/support/directory_sync_client_mock.ex: Language not supported
  • test/support/directory_sync_client_mock_test.exs: Language not supported
  • test/support/events_client_mock.ex: Language not supported
  • test/support/organization_domains_client_mock.ex: Language not supported
  • test/support/organizations_client_mock.ex: Language not supported
  • test/support/passwordless_client_mock.ex: Language not supported
  • test/support/portal_client_mock.ex: Language not supported
Comments suppressed due to low confidence (1)

README.md:37

  • [nitpick] The removal of the stray '###' markdown header just above the SDK Versioning section may have been unintentional. Please confirm if this deletion was deliberate.
## SDK Versioning

@marktran marktran requested a review from hexedpackets May 16, 2025 19:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant