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

feat: Require Swift DocC only when env var is set #1498

Merged
merged 1 commit into from
May 14, 2024

Conversation

jbelkins
Copy link
Contributor

Description of changes

Removes DocC as a SDK dependency unless the env var AWS_SWIFT_SDK_ENABLE_DOCC is set, since it is essentially unused unless documentation is actually being generated. There is generally not a reason to enable it by default for customers.

AWS_SWIFT_SDK_ENABLE_DOCC is set for the "generate documentation" job on Github, where DocC is actually used.

New/existing dependencies impact assessment, if applicable

No new dependencies were added to this change.

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

@jbelkins jbelkins requested review from dayaffe and sichanyoo May 13, 2024 23:53
Copy link
Contributor

@sichanyoo sichanyoo left a comment

Choose a reason for hiding this comment

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

There's a swiftlint warning that got past review from some other PR. Address before merge if possible

@jbelkins jbelkins merged commit f62ceed into main May 14, 2024
29 checks passed
@jbelkins jbelkins deleted the jbe/disable_docc_by_default branch May 14, 2024 16:53
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