Skip to content

Latest commit

 

History

History
146 lines (90 loc) · 5.03 KB

CONTRIBUTING.md

File metadata and controls

146 lines (90 loc) · 5.03 KB
Raw

Contributing

Downloading Source

Download the source and install all submodules if you have not already, by running the following from the root of the repository.

git clone --recurse-submodules [email protected]:maplibre/maplibre-native.git
cd maplibre-native

Bazel

Bazel is used for building on iOS.

You can generate an Xcode project thanks to rules_xcodeproj intergration.

You need to install bazelisk, which is a wrapper around Bazel which ensures that the version specified in .bazelversion is used.

brew install bazelisk

Creating config.bzl

Configure Bazel, otherwise the default config will get used.

cp platform/darwin/bazel/example_config.bzl platform/darwin/bazel/config.bzl

You need to set your BUNDLE_ID_PREFIX to be unique (ideally use a domain that you own in reverse domain name notation).

You can keep leave the APPLE_MOBILE_PROVISIONING_PROFILE_NAME alone.

Set the Team ID to the Team ID of your Apple Developer Account (paid or unpaid both work). If you do not know your Team ID, go to your Apple Developer account, log in, and scroll down to find your Team ID.

If you don't already have a developer account, continue this guide and let Xcode generate a provisioning profile for you. You will need to update the Team ID later once a certificate is generated.

Create the Xcode Project

Run the following commands:

bazel run //platform/ios:xcodeproj --@rules_xcodeproj//xcodeproj:extra_common_flags="--//:renderer=metal"
xed platform/ios/MapLibre.xcodeproj

Then once in Xcode, click on "MapLibre" on the left, then "App" under Targets, then "Signing & Capabilities" in the tabbed menu. Confirm that no errors are shown.

image

Try to run the example App in the simulator and on a device to confirm your setup works.

Important

The Bazel configuration files are the source of truth of the build configuration. All changes to the build settings need to be done through Bazel, not in Xcode.

Troubleshooting Provisioning Profiles

If you get a Python KeyError when processing provisioning profiles, you probably have some really old or corrupted profiles.

Have a look through ~/Library/MobileDevice/Provisioning\ Profiles and remove any expired profiles. Removing all profiles here can also resolve some issues.

Using Bazel from the Command Line

It is also possible to build and run the test application in a simulator from the command line without opening Xcode.

bazel run //platform/ios:App --//:renderer=metal

You can also build targets from the command line. For example, if you want to build your own XCFramework, see the 'Build XCFramework' step in the iOS CI workflow.

Render Tests

To run the render tests, run the RenderTest target from iOS.

When running in a simulator, use

# check for 'DataContainer' of the app with `*.maplibre.RenderTestApp` id
xcrun simctl listapps booted

to get the data directory of the render test app. This allows you to inspect test results. When adding new tests, the generated expectations and actual.png file can be copied into the source directory from here.

C++ Unit Tests

Run the tests from the CppUnitTests target in Xcode to run the C++ Unit Tests on iOS.

Swift App

There is also an example app built with Swift instead of Objective-C. The target is called MapLibreApp and the source code lives in platform/ios/app-swift.

Documentation

We use DocC for documentation. You need to have aws-cli installed to download the resources from S3 (see below). Run the following command:

aws s3 sync --no-sign-request "s3://maplibre-native/ios-documentation-resources" "platform/ios/MapLibre.docc/Resources"

Then, to build the documentation locally, run the following command:

platform/ios/scripts/docc.sh preview

Resources

Resources like images should not be checked in but should be uploaded to the S3 Bucket. You can share a .zip with all files that should be added in the PR.

If you want to get direct access you need an AWS account to get permissions to upload files. Create an account and authenticate with aws-cli. Share the account ARN that you can get with

aws sts get-caller-identity

Examples

The code samples in the documentation should ideally be compiled on CI so they do not go out of date.

Fence your example code with

// #-example-code(LineTapMap)
...
// #-end-example-code

Prefix your documentation code block with

<!-- include-example(LineTapMap) -->

```swift
...
```

Then the code block will be updated when you run:

node scripts/update-ios-examples.mjs