rules_apple icon indicating copy to clipboard operation
rules_apple copied to clipboard

Documentation revamp ideas

Open keith opened this issue 3 years ago • 3 comments

One idea is to do something like https://github.com/buildbuddy-io/rules_xcodeproj/blob/main/docs/usage.md which links out to larger examples but attempts to be the central place for discovering all the random features these rules support

keith avatar Nov 17 '22 16:11 keith

Something that could fit in above documentation is the snippet for what to exclude from remote cache and remote execution:

modify_execution_info=^(BitcodeSymbolsCopy|BundleApp|BundleTreeApp|DsymDwarf|DsymLipo|GenerateAppleSymbolsFile|ObjcBinarySymbolStrip|CppLink|ObjcLink|ProcessAndSign|SignBinary|SwiftArchive|SwiftStdlibCopy)$=+no-remote,^(BundleResources|ImportedDynamicFrameworkProcessor)$=+no-remote-exec

Context: https://bazelbuild.slack.com/archives/CD3QY5C2X/p1678984234867509

acecilia avatar Mar 16 '23 16:03 acecilia

Another thing that could fit in this documentation are the details needed to create an IPA that includes dsyms, to be uploaded to appstoreconnect

Context: https://bazelbuild.slack.com/archives/CD3QY5C2X/p1679329874671509

acecilia avatar Mar 20 '23 22:03 acecilia

I think it would be nice for us to add the required load statements to our examples for easy copy-pasting and to reduce some confusion https://github.com/bazelbuild/rules_apple/issues/1934

keith avatar Mar 28 '23 16:03 keith