Skip to content

AGENTS.md

Latest commit

 

History

History
47 lines (35 loc) · 2.23 KB

AGENTS.md

File metadata and controls

47 lines (35 loc) · 2.23 KB
Raw

Agent Notes

Apple XCFramework Artifacts

Apple binary artifacts are generated build outputs. They contain framework-wrapped XCFrameworks for iOS device, iOS simulator, and macOS app integration, plus a generated BrainFlowSwiftBinaryPackage for app developers.

Regenerate the artifacts from the repository root:

tools/apple/regenerate_artifacts.sh

Verify an existing artifact tree:

tools/apple/verify_xcframeworks.sh build/apple_xcframeworks

The regeneration script builds native BrainFlow Apple slices, packages the XCFrameworks, verifies the required core frameworks, and creates:

  • BrainFlowAppleXCFrameworks.zip for complete archive downloads.
  • SwiftPMArtifacts/*.xcframework.zip with each .xcframework at the ZIP root.
  • BrainFlowSwiftPackageRemote, a generated URL-based SwiftPM package manifest.
  • swiftpm-checksums.txt and swiftpm-checksums.json from swift package compute-checksum.

By default, tools/apple/regenerate_artifacts.sh and tools/apple/build_xcframeworks.sh write to build/apple_xcframeworks. Do not commit build/, build_apple/, swift_package/Artifacts/Apple, or local installed/ outputs.

The iOS demo and macOS packaging script default to build/apple_xcframeworks/XCFrameworks. CI may override artifact paths with BRAINFLOW_APPLE_XCFRAMEWORKS_DIR.

When changing Apple artifact generation, regenerate locally and run verification. CI uploads the aggregate archive, the individual SwiftPM .xcframework.zip assets, checksums, generated remote Swift package, and manifest.json as the distributable artifact set. Generated framework headers and binaries should come from the scripts, not from files copied into the repository.

For a BrainFlow release or Apple-library refresh, build from the release commit/tag with BRAINFLOW_VERSION set. Set BRAINFLOW_APPLE_RELEASE_BASE_URL when release assets are hosted outside the default GitHub Release tag URL. Regenerate artifacts, verify the generated tree, smoke-test the generated Swift binary package, validate the iOS/macOS sample apps against the regenerated XCFrameworks, and publish the individual SwiftPM ZIPs next to their checksum files. Do not manually patch release frameworks after generation; update source and rerun the script.