Tammy

Website: https://tammy.connect2x.de
Matrix-Room: #tammy:imbitbu.de

White label messenger based on Trixnity Messenger. Please consult the Readme there for additional information.

Run locally

If you run the messenger from the IDE or command line, the

Desktop

./gradlew run

Android

In Android Studio or IntelliJ, choose the Android configuration and run on an emulated or your physical device.

Web

./gradlew wasmJsBrowserDevelopmentRun

Create release

1. Create a git commit bump version with the following changes:
   • appPublishedVersion (e. g. 26.4.0) set to the version that is going to be published.
   • appVersion must be the same as appPublishedVersion.
   • Updated CHANGELOG.md containing a section about the new version.
   • Cancel triggered pipeline.
2. Create a version-tag of the form v26.4.0.
   • The version must be the same as appPublishedVersion.
   • This will trigger a pipeline creating all distributions, uploading them into package registry and linking them in a newly created GitLab release.
3. Create a git commit with [skip-ci] in the commit message and the following changes:
   • appPublishedVersion stays at the version, that has been published (e. g. 26.4.0).
   • appVersion increased to the next version (e. g. 26.4.1) as this is used for DEV builds.

Fastlane

When running locally, you must set TAMMY_BUILD_FLAVOR to PROD (e.g. by prepending TAMMY_BUILD_FLAVOR=PROD to each command).

Install fastlane by installing ruby and running:

bundle update

Create screenshots

Create new screenshots for the App.

When using a Mac, you may do first (this needs Android SDK command line tools to be installed):

# macOS
export PATH="$PATH:$HOME/Library/Android/sdk/emulator:$HOME/Library/Android/sdk/tools:$HOME/Library/Android/sdk/cmdline-tools/latest/bin/"

# linux
export PATH="$PATH:$HOME/Android/Sdk/emulator:$HOME/Library/Android/sdk/tools:$HOME/Android/Sdk/cmdline-tools/latest/bin/"

After that you can start the emulators:

./fastlane/run_screenshot_emulators.sh

And create screenshots:

TAMMY_BUILD_FLAVOR=PROD bundle exec fastlane android screenshots

After that you can stop the first script and delete the emulators:

./fastlane/delete_screenshot_emulators.sh

For iOS you have to manually add the following files under Build Phases -> Copy Bundle Resources (otherwise fastlane will crash in the CI...):

• lognity.json
• Tammy.icon
• main.swift
• all the files in iosApp/Screenshots
• Since the CI will crash if those files are mentioned in the .xcproject file, do NOT commit those changes!

Then, run fastlane ios screenshots

Important environment variables

This does not include default GitLab environment variables that are used.

• AZURE_ARTIFACT_SIGNING_METADATA_FILE_BASE64
• AZURE_TENANT_ID
• AZURE_CLIENT_ID
• AZURE_CLIENT_SECRET
• ANDROID_RELEASE_STORE_FILE_BASE64
• ANDROID_RELEASE_STORE_PASSWORD
• ANDROID_RELEASE_KEY_ALIAS
• ANDROID_RELEASE_KEY_PASSWORD
• APPLE_KEYCHAIN_FILE_BASE64
• APPLE_KEYCHAIN_PASSWORD
• APPLE_TEAM_ID
• APPLE_ID
• APPLE_NOTARIZATION_PASSWORD
• SSH_PASSWORD_APP: Web app deployment
• SSH_PASSWORD_WEBSITE: Website deployment