Appmagic Flutter Actions

A powerful VS Code extension that streamlines Flutter CI/CD workflows with GitHub Actions integration, secrets management, and custom runners.

Features

• 🚀 GitHub Actions Integration: Configure and manage GitHub Actions workflows directly from VS Code
• 🔐 Secrets Management: Securely manage GitHub repository secrets without leaving your editor
• 🖥️ Custom Runners: Set up and manage self-hosted runners for your Flutter projects
• 📊 Build Monitoring: View real-time build status and history with detailed logs
• ⚡ Quick Actions: Trigger builds, deploy workflows, and download artifacts with a single click
• 🎨 Visual Workflow Editor: Configure complex CI/CD pipelines through an intuitive UI

Installation

1. Open VS Code
2. Press Ctrl+P / Cmd+P to open the Quick Open dialog
3. Type ext install appmagic.appmagic and press Enter
4. Reload VS Code when prompted

Getting Started

Prerequisites

• VS Code version 1.85.0 or higher
• A Flutter project with a pubspec.yaml file
• GitHub repository with Actions enabled
• GitHub Personal Access Token with appropriate permissions

Initial Setup

1. Open your Flutter project in VS Code
2. Run the command Appmagic: Initialize Appmagic Project from the Command Palette (Ctrl+Shift+P / Cmd+Shift+P)
3. Configure your GitHub token when prompted
4. The extension will automatically detect your Flutter project and enable all features

Commands

All commands are available through the Command Palette (Ctrl+Shift+P / Cmd+Shift+P):

Views

The extension adds a dedicated activity bar icon with four views:

Workflows View

• List all GitHub Actions workflows in your repository
• Quick access to workflow configuration
• Visual indicators for workflow status

Recent Builds View

• Real-time build status monitoring
• Detailed logs for each build step
• Quick actions for build management

Secrets View

• Manage repository and environment secrets
• Secure encryption using libsodium
• Visual secret validation

Runners View

• Monitor self-hosted runner status
• Add or remove runners
• View runner specifications and labels

Configuration

Configure the extension through VS Code settings (File > Preferences > Settings):

{
  "appmagic.githubToken": "your-github-token",
  "appmagic.defaultBranch": "main",
  "appmagic.workflowPath": ".github/workflows",
  "appmagic.autoSync": true
}

Settings

GitHub Token Permissions

Your GitHub Personal Access Token needs the following permissions:

• repo - Full control of private repositories
• workflow - Update GitHub Action workflows
• admin:org - Manage organization runners (if using org runners)

Development

Prerequisites

• Node.js 18.x or higher
• npm or pnpm package manager
• TypeScript 5.3.2 or higher

Building from Source

# Clone the repository
git clone https://github.com/appmagic/vscode-extension.git
cd vscode-extension

# Install dependencies
npm install

# Compile TypeScript
npm run compile

# Build webview components
npm run build-webview

# Watch for changes (development mode)
npm run watch
npm run watch-webview

Running Tests

# Run linter
npm run lint

# Run tests
npm test

Debugging

1. Open the project in VS Code
2. Press F5 to launch a new Extension Development Host window
3. The extension will be automatically loaded in the new window

For detailed debugging instructions, see DEBUG_INSTRUCTIONS.md.

Tech Stack

• Extension Core: TypeScript, VS Code Extension API
• UI Components: React 19, Material-UI v7
• State Management: TanStack React Query
• Form Handling: React Hook Form with Zod validation
• GitHub Integration: Octokit REST API
• Build System: Vite, TypeScript Compiler

Contributing

We welcome contributions! Please see our Contributing Guide for details.

Development Workflow

1. Fork the repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Troubleshooting

Extension not activating

• Ensure you have a pubspec.yaml file in your workspace
• Check that VS Code version is 1.85.0 or higher
• Try reloading the window (Ctrl+R / Cmd+R)

GitHub API errors

• Verify your GitHub token has the required permissions
• Check your internet connection
• Ensure the repository has Actions enabled

Build triggers not working

• Confirm workflows are properly configured in .github/workflows
• Check that the workflow file syntax is valid
• Verify branch protection rules aren't blocking the trigger

Support

• Issues: GitHub Issues
• Discussions: GitHub Discussions
• Documentation: Full Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

• Flutter team for the excellent mobile framework
• GitHub Actions team for the powerful CI/CD platform
• VS Code team for the extensible editor platform

Publisher: Appmagic Version: 0.1.0 Marketplace: Visual Studio Marketplace