Teleport (Gradle Plugin)

Teleport is a Gradle plugin that automates the delivery process of Android applications to a Telegram channel.

Usage

To use Teleport and send your Android application to a Telegram channel, you first need to create a Telegram bot and add it to your channel. Then, you need to add the bot token and chat ID to your secret.json file. Here’s how you can create a bot and add it to your channel:

1. Log in to your Telegram account in the Telegram app.
2. Open a chat with @BotFather and send the /newbot command to create a new bot.
3. Choose a display name and username for your bot.
4. After creating the bot, copy the bot token provided to you and paste it into the secret.json file in your project.
5. Add the bot to the Telegram channel where you want to send your application.
6. To find the chat ID of the channel, go to the channel and click on its name at the top of the page. The channel will open, and its address will be displayed to you. The chat ID is the number after the - sign in the address. Or send a message from the group or channel you added your bot to @usereInfoBot to give you the chat id Add this chat ID to the secret.json file.

After completing these steps, your secret.json file should look like this:

{
  "botToken": "YOUR_BOT_TOKEN",
  "chatID": "YOUR_CHAT_ID"
}

Now, you can use the ./gradlew uploadApk command to send your APK file to the Telegram channel.

Customization

Teleport provides several parameters that you can customize to fit your needs:

• enabled: Enables or disables task execution.
• attemptCount: Sets the number of retries when the task fails.
• attemptDuration: Sets the time interval between retries.
• caption: Specifies a message for the APK file that will be sent.
• applicationName: Specifies a name for the APK file that will be sent.
• buildType: Sets the build type (debug or release).

To customize these parameters, add the following code to your build.gradle file:

configure<TeleportExtension> {
    enabled.set(true)
    attemptCount.set(3)
    attemptDuration.set(5000)
    caption.set("My app")
    applicationName.set("MyAppName")
    buildType.set(ApplicationMode.DEBUG)
}

If you do not specify a value, the default value will be set

License

Teleport is licensed under the MIT License. See the LICENSE file for more information.

GitHub

View Github