This is the repository for TIDAL SDK modules for iOS development.
- Clone the repository
- Run
./local-setup.sh - All done!
Run the generate-module.sh script. It will prompt you to enter a module name using PascalCase.
After confirming the name, a new directory will be created with the basic module setup. Open this in your IDE and start working.
- Navigate to the project inside the project navigator
- Select "Package Dependencies" tab
- Tap the plus button
- Inside the search, paste the following link: https://github.com/tidal-open-source/tidal-sdk-ios
- Select the packages you wish to import
note: make sure to select the latest version or a desired branch when importing the SPM
Using Xcode
- Go to
Product > Build documentation
Using the command line
- To generate a preview of the documentation from the command line, you first need to set the environment variable
$INCLUDE_DOCC_PLUGIN=true - Then, run the following command for the desired module you want to preview documentation
swift package --disable-sandbox preview-documentation --target Module
-
Bump the version stored in
version.txtin the repo root directory to the desired value. Follow Semantic Versioning. Also, you cannot downgrade - the CI/CD pipeline will refuse to work with downgrades. -
Open a Pull Request with your version bump, get it approved and merge it. A release draft will be created for the module you changed.
-
Find your draft in the releases list and add some meaningful sentences about the release, changelog style (Note: This paragraph is temporary, as we will automate and regulate changelog creation, but for now, you are free to just type)
-
Check in with your teammates, lead, the module's owner etc. to make sure the release is ready to go.
-
Click
Publishat the bottom of your draft release. This will trigger a workflow to tag the release commit.