flutter_release_x 0.1.0

A CLI tool to easily build, release, and share Flutter apps. Supports cloud uploads, QR codes, and download links for fast distribution.

example/README.md

Flutter Release X Example

A powerful CLI tool to build and release Flutter apps effortlessly. Generate release builds, upload to the cloud, and share QR codes and download links for quick and easy distribution.

Installation

You can install Flutter Release X globally using dart:

dart pub global activate flutter_release_x

copied to clipboard

Alternatively, add it as a dependency in your pubspec.yaml:

dart pub add flutter_release_x

copied to clipboard

🛠 Usage

Flutter Release X provides easy commands to build, upload, and manage your releases. Here are the main commands:

Command	Description
frx build	Builds the release APK, uploads to GitHub, and generates a QR code & link.
frx build -s	Displays the current configuration settings. This helps verify if your setup is correct.
frx build -c <path_to_config>	Use this flag to specify a custom configuration file path, overriding the default config.yaml.

Example

• To build the release APK, upload it to Cloud, and generate a QR code & Downloadable link:

  frx build
  

  copied to clipboard

• To verify your configuration, run:

  --show-config: Displays the current configuration settings. By default, it reads from config.yaml. If a custom file path is provided, it reads from the specified file. Use this option to verify that the setup is correctly configured.

  frx build -s
  

  copied to clipboard

• --config: Use this flag to specify a custom configuration file path, overriding the default config.yaml. This allows you to point to a specific configuration file as needed.

  frx build -c config/file/path
  

  copied to clipboard

⚙️ Configuration

Create a config.yaml file in the root directory of your project to specify your upload options and QR code generation settings:

# Path to Flutter binary
# Example for Windows: C:/dev/flutter/bin/flutter.bat
# Example for macOS: /Users/USER_NAME/development/flutter/bin/flutter
flutter_path: FLUTTER/BINARY/PATH

upload_options:
  github:
    enabled: true
    token: YOUR_GITHUB_TOKEN # Required: Personal Access Token for GitHub
    repo: REPO/PATH # Required: GitHub repository path, e.g., RittikSoni/Flutter-Release-X
    tag: v0.0.1 # Release tag (e.g., version number)

  google_drive:
    enabled: true
    client_id: YOUR_CLIENT_ID # Required: Google API Client ID
    client_secret: YOUR_CLIENT_SECRET # Required: Google API Client Secret

  slack:
    enabled: true
    bot_user_oauth_token: YOUR_BOT_TOKEN # Required: Slack Bot OAuth Token, e.g., xoxb-XXXXXXXXX-XXXXXXXXX-XXXXXXXXXXXXX
    default_channel_id: CHANNEL_ID # Required: Slack channel ID, e.g., CXXXXXXXXX
    share_QR: true # Optional: Share QR code in Slack (default: true)
    share_link: true # Optional: Share build download link in Slack (default: true)
    custom_message: "🚀 Check out the latest build! Download your app now!" # Custom message to accompany the link
    mention_users: ["U0XXXXXXX", "U08XXXXXXXX"] # List of Slack user/member IDs to mention. Note: not username or display name.

# QR Code generation settings
qr_code:
  enabled: true # Whether to generate QR codes (true/false)
  save_file: true # Save the QR code image to the file system (true/false)
  show_in_command: true # Display QR code in the command line output (true/false)
  size: 256 # Size of the generated QR code (pixels)
  error_correction_level: low # Error correction level: low, medium, quartile, high
  save_path: "./release-qr-code.png" # File path to save the QR code image

copied to clipboard

Steps for Setup

1. Configure config.yaml Create a config.yaml file with the settings shown above. If you have a custom file path, you can specify it with the -c flag.

2. Generate Cloud Credentials For cloud uploads (GitHub or Google Drive), follow these steps:

   • GitHub Configuration

     • Generate a Personal Access Token (PAT) in GitHub and add it to your config.yaml.

   • Google Drive Configuration

     • Create a Google Cloud Project and enable the Google Drive API.
     • Generate OAuth 2.0 credentials for your app and add the client_id and client_secret to your config.yaml.

3. Run the Tool After setting up the configuration, run:

   frx build
   

   copied to clipboard

   This command will build your Flutter project, upload it, and generate a QR code & shareable link.

🌐 Cloud Integration

Generating a GitHub Personal Access Token

To enable your Flutter CLI tool to upload and delete releases on GitHub, you'll need to generate a Personal Access Token (PAT) with the appropriate permissions. Follow the steps below to create and configure your token.

Steps to Generate a GitHub Token

1. Open the GitHub Token Generation Page:

   • Generate GitHub Token.

2. Set the Token Name:

   • In the Note field, enter a descriptive name for your token, such as Flutter Release X Token.

3. Select Scopes:

   • Under Select scopes, check the following permissions:
     • repo (Full control of private repositories)
       • This includes access to public and private repositories, which is required for uploading and deleting releases.

4. Generate the Token:

   • Click the Generate token button at the bottom of the page.
   • Copy the token immediately, as you won’t be able to see it again.

5. Set Up Your Project:

   github:
     enabled: true
     token: YOUR_GITHUB_TOKEN
   

   copied to clipboard

Google Drive Configuration

To upload files to Google Drive, follow these steps to set up your credentials:

1. Create a Google Cloud Project:

   • Go to the Google Cloud Console.
   • Create a new project or select an existing one.

2. Enable the Drive API:

   • In the Google Cloud Console, navigate to APIs & Services > Library.
   • Search for "Google Drive API" and enable it.

3. Create OAuth 2.0 Credentials:

   • Go to APIs & Services > Credentials.
   • Click on Create Credentials and select OAuth Client ID.
   • Configure the consent screen if prompted.
   • Set the application type to Desktop App.
   • Note down the generated Client ID and Client Secret.

4. Set Up Your Project:

   google_drive:
     enabled: true
     client_id: YOUR_CLIENT_ID
     client_secret: YOUR_CLIENT_SECRET
   

   copied to clipboard

   By following these steps, your application will be able to authenticate with Google Drive using the client ID and secret to upload files.

Slack Configuration Setup Guide

To configure Slack, follow these simple steps:

1. Create a Slack App

• Go to the Slack API: Your Apps page.
• Click on Create New App.
• Choose From Scratch and give your app a name (e.g., "Build Notifier Bot") and select your workspace.
• Click Create App.

2. Add Scopes for the App

Scopes define the permissions your app will have. To upload QR code and Share Flutter build Download link, you'll need to add the following scopes:

For Uploading Files:

• Go to the OAuth & Permissions page in your Slack App's settings.
• Under Scopes, find the section called Bot Token Scopes.
• Add the following scope:
  • files:write — Allows your app to upload files.

For Sending Chat Messages:

• Under the same Bot Token Scopes section, add:
  • chat:write — Allows your app to send messages to channels.

3. Install the App to Your Workspace

• Once you've added the required scopes, scroll to the OAuth & Permissions page.
• Click the Install App to Workspace button.
• You'll be prompted to authorize the app with the selected permissions. Click Allow to proceed.

4. Get the Bot User OAuth Token

After installing the app, you will receive a Bot User OAuth Token. This token is required for your Slack configuration to upload files and send messages.

• In the OAuth & Permissions page, under OAuth Tokens & Redirect URLs, copy the Bot User OAuth Token (it should look like xoxb-XXXXXXXXX-XXXXXXXXX-XXXXXXXXXXXXX).
• This is your YOUR_BOT_TOKEN in the configuration.

5. Find Your Channel ID

The CHANNEL_ID is the unique identifier for the Slack channel where the bot will send messages and share files.

To Find the Channel ID:

• Go to the desired channel in your Slack workspace.
• Click on the channel name at the top to open the channel details.
• In the URL of the channel, you will see something like https://app.slack.com/client/TXXXXXXXX/CXXXXXXXXX.
• The part after the last / (e.g., CXXXXXXXXX) is your CHANNEL_ID.

6. Get Member/User IDs to Mention

If you want to mention specific users in the Slack message, you will need their Slack User IDs.

To Find a User's ID:

• Open the user's profile by clicking on their name in Slack.
• Click on three dots and Copy Member Id (e.g., UXXXXXXXX) is the user's User ID.
• Repeat this for each user you want to mention and collect their User IDs.

---

Now, you can use the YOUR_BOT_TOKEN, CHANNEL_ID, and member_ids in your configuration to automate Slack file uploads and download link sending.

📱 QR Code Configuration

Flutter Release X can generate QR codes for quick sharing. The QR codes can be customized with various settings.

Setting	Description
enabled	Enable or disable QR code generation. (true/false)
save_file	Flag to save the QR code image. (true/false)
show_in_command	Display the QR code in the command line output. (true/false)
size	QR code image size (e.g., 256).
error_correction_level	Error correction level (low, medium, quartile, high).
save_path	File path to save the QR code image.