Skip to content

rexthecoder/Pinky

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Pinky Flutter Action

Pinky allows you to deploy flutter apk to various platform at ease. Currently, we support.

  • Telegram
  • Slack
  • Discord

Inputs

Name Required Description
flutter_version false Specify the current version of flutter your project uses
flutter_channel false Specify the channel your project support
path true Specify where your generated apk or ipa file is located
slack_token false Your slack bot auth token
telegram_token false Your telegram bot token generated by bot father
telegram_chat_id false The id of the channel you want the apk to be send to
channel_id false The slack channel name you want the apk to be send to
filename false The name you want to give to the file
comment false The message you want to attach to the file while sending it
webhook_url false Your discord webhook url.
usePicky false Indicate either you wanna use our picky bot
web false Indicate either you want to deploy the web file

Usage

The following give you a preview of the set up

on: [push]

jobs:
    runs-on: ubuntu-latest
    name: Pinky Test
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Generate Flutter apk 🍻
        uses: ./ 
        with:
          slack_token: ${{ secrets.SLACK_TOKEN }}
          path:  build/app/outputs/flutter-apk/app-release.apk
          channel: general
          filename: app-armeabi-v7a-debug.apk
          comment: "New Release"
          web: false
          channel_id: 'C03SQ349DHS'
          telegram_token: ${{ secrets.TELEGRAM_TOKEN }}
          telegram_chat_id: ${{ secrets.TELEGRAM_CHAT_ID }}
          webhook_url: ${{ secrets.WEBHOOK_URL }}

Using Our Slack Bot

  • Set usePicky to true

  • Click on the below button

Add to Slack

  • set the channel you added the bot to. eg. channe_id:C03SQ349DHS. You can check this tutorial incase you don't know how to get a channel id.

Setting up Telegram

We planning to have our custom chatbot who does the work automatically.After the next update, you will automate things at ease.

  • Create a bot with BotFather.
    • Start a new conversation with the `BotFather`
    • Send /newbot to create a new Telegram bot.
    • When asked, enter a name for the bot.
    • Give the Telegram bot a unique username. Note that the bot name must end with the word "bot" (case-insensitive).
    • Copy and save the Telegram bot's access token for later steps.
  • Provide the access token to our telegram_token

  • Copy your channel id. The channel you want the apk to be sent to. ( Make sure the bot has been added over there).

How to get Telegram channel id

Skip step 2 if your channel is public

  1. log in under your account at web version of Telegram. Incase your channel is public, just copy the channel name as the telegram_chat_id.

  2. Find your channel. See to your URL. It should be like https://web.telegram.org/z/#-1543515057.

  3. Grab "1543515057" from it, and add "-100" as a prefix.

Setting up Discord

Note that, discord has file limit size(8mb) for channels which has no booster

  • Watch this video to learn how to get your webhook.
  • Copy the webhook link and provide it to webhook_url

That's all you need to get discord to work.

Show some ❤️ and star the repo

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages