ehealthsolutions/element-x-ios
3
0
Fork 0
mirror of https://github.com/Novaloop-AG/element-x-ios.git synced 2026-11-03 06:55:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Swiftformat on githooks + New swift run tools setup command (#563)

Browse Source
This commit is contained in:
Mauro
2023-02-10 14:04:00 +01:00
committed by GitHub
parent f0a4cfd946
commit c8fb93e00d
11 changed files with 123 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+23 -2
View File
@@ -6,11 +6,24 @@ Element iOS support can be found in this room: [![Element iOS Matrix room #eleme
## Setting up a development environment
### Setup Project
It's mandatory to have [homebrew](https://brew.sh/) installed on your mac, and run after the checkout:
```
swift run tools setup-project
```
This will:
- Install various brew dependencies required for the project (like xcodegen).
- Set up git to use the shared githooks from the repo, instead of the default ones.
- Automatically run xcodegen for the first time.
### Xcode
We suggest using an Xcode version later than 13.2.1.
The Xcode project can be directly compiled after checkout through the shared ElementX scheme which includes the main application as well as the unit and UI tests.
The Xcode project can be directly compiled through the shared ElementX scheme which includes the main application as well as the unit and UI tests.
The Xcode project itself is generated through [xcodegen](https://github.com/yonaskolb/XcodeGen) so any changes shouldn't be made directly to it but to the configuration files.
@@ -38,12 +51,20 @@ The project depends on some tools for the build process. These are all included
brew bundle
```
Git LFS is used to store UI test snapshots. After cloning the repo this can be configured by running
Git LFS is used to store UI test snapshots. `swift run tools setup-project` will already install it, however it can also be installed after a checkout by running:
```
git lfs install
```
### Githooks
The project uses its own shared githooks stored in the .githooks folder, you will need to configure git to use such folder, this is already done if you have run the setup tool with `swift run tools setup-project` otherwise you would need to run:
```
git config core.hooksPath .githooks
```
### Continuous Integration
ElementX uses Fastlane for running actions on the CI and tries to keep the configuration confined to either [fastlane](fastlane/Fastfile) or [xcodegen](project.yml).