Technical Documentation
Branches
Main
This is the main branch where we develop features. Development itself should occur in feature or bug branches that can then be integrated to master by creating a pull request.
Builds are automatically started any time a new commit is made to main, which results in a:
Release being created on GitHub:
- Latest Release
- Windows release build package is uploaded to the release above
- iOS TestFlight build being automatically made available to all internal developers
- Mac Catalyst TestFlight build being automatically made available to all internal developers
Staging
This represents the next release candidate. Staging should always be at least one version number behind main.
- Builds are automatically started any time a new commit is made to staging, which results in a:
- Release being created on GitHub: Latest Release
- Windows release build package is uploaded to the release above
- iOS TestFlight build being automatically made available to all internal developers
- Mac Catalyst TestFlight build being automatically made available to all internal developers
Live
This represents the state of the latest released build. Note that all projects also have the equivalent of this branch. Never push to this branch!