StanfordBDHG / ResearchKit

ResearchKit with Swift Package Manager (SPM), SwiftUI, C++ Interoperability, and visionOS support
https://swiftpackageindex.com/StanfordBDHG/ResearchKit/documentation/researchkitswiftui
Other
7 stars 3 forks source link

Lift to upstream ResearchKit 2.2.15 #14

Closed philippzagar closed 7 months ago

philippzagar commented 7 months ago

Lift to upstream ResearchKit 2.2.15

:recycle: Current situation & Problem

The current used ResearchKit version of our fork is 2.2.12, which is not up to date with the published ResearchKit in 2.2.15. Furthermore, as described in #13, we currently don't validate within the CI if ResearchKit compiles with active Swift / C++ interop.

:gear: Release Notes

:books: Documentation

Documented CI approach

:white_check_mark: Testing

Built code (in C++ interop mode) via CI pipeline

Code of Conduct & Contributing Guidelines

By submitting creating this pull request, you agree to follow our Code of Conduct and Contributing Guidelines:

philippzagar commented 7 months ago

@PSchmiedmayer Please also adjust the merge checks of the repo

PSchmiedmayer commented 7 months ago

@philippzagar I adjusted the merge checks.

One thing that I was thinking was maybe adding a GitHub Note (in the formatting we have in some READMEs of our other repos) that notes how this repo is different from the main RK repo? I could see this right before the badges.

Maybe something like:

NOTE:
This repository is a fork of the ResearchKit project by Apple, adding support for:

  • The Swift Package Manager & the usage as a binary dependency speeding up build times ...
  • Successful building using Swift's C++ Interoperability ...

Feel free to add and adapt this as you want to; serves more as a placeholder and idea.

philippzagar commented 7 months ago

@philippzagar I adjusted the merge checks.

One thing that I was thinking was maybe adding a GitHub Note (in the formatting we have in some READMEs of our other repos) that notes how this repo is different from the main RK repo? I could see this right before the badges.

Maybe something like:

NOTE: This repository is a fork of the ResearchKit project by Apple, adding support for:

  • The Swift Package Manager & the usage as a binary dependency speeding up build times ...
  • Successful building using Swift's C++ Interoperability ...

Feel free to add and adapt this as you want to; serves more as a placeholder and idea.

Great idea @PSchmiedmayer, I think we have enough diff to upstream that this definitely makes sense! I looked through the diff we currently have to upstream ResearchKit and the main two points (SPM support via binary target as well as C++ interop) were already stated by you. All the rest is not really noteworthy. Feel free to check out the README!

philippzagar commented 7 months ago

@PSchmiedmayer You also need to merge the PR as not all commits from upstream were signed.

PSchmiedmayer commented 7 months ago

Thank you @philippzagar; I will merge the PR 👍