acme-portal

Important: This extension is currently in alpha and primarily for demonstration purposes. APIs may still change frequently.

This project is a VSCode extension that allows users to manage deployments of their python projects. Data for the extension is provided via the open project using acme-portal-sdk. Sample project using it is available at acme-prefect.

For explanation of main concepts used by the extension view acme-portal-sdk docs

📚 Extension Documentation - Complete user guide, API reference, and contributing guidelines

Features

• Show and navigate all Flows in a project
• View existing Flow deployments across different Environments (and branches)
• Navigate to deployment URL from deployment tree view
• Deploy a flow to a given starting environment, e.g. dev
• Promote a deployment from a given environment to another environment
• View source code differences between environments
• Progress Notifications: Real-time progress updates in the notification bar for all operations

Video Demonstration

Watch how to:

• Navigate Flows and View Deployments
• Deploy Flow Demonstration
• View Deployment
• Promote Deployment
• Compare Flow Deployment Versions

Requirements

• VSCode version 1.99.3 or higher
• Microsoft Python VSCode Extension needs to be installed
• Python environment used by your project needs to be selected with Python: Select Interpreter command
• Project needs to add as dependency & setup acme-portal-sdk
• git CLI needs to be installed
• Opened project needs to have remote source pointing to a GitHub repository (Other repos to be supported)

Development

For detailed development setup, contribution guidelines, and release process, see CONTRIBUTING.md.

Quick Start for Developers

1. Setup: Clone the repository and run npm install
2. Development: Press F5 in VS Code to launch the Extension Development Host
3. Testing: Open acme-prefect repository in the extension host
4. Python Setup: Create virtual environment and select Python interpreter

Essential Commands

npm install     # Install dependencies
npm run compile # Compile TypeScript
npm run lint    # Check code quality
npm test        # Run test suite
npm run package # Build production package

Automated Release Process

Releases are fully automated - just create and push a git tag:

git tag v1.0.0
git push origin v1.0.0

The release workflow automatically:

• Runs comprehensive tests across platforms
• Packages and validates the extension
• Creates GitHub release with automated changelog
• Publishes to VS Code Marketplace (when configured)
• Updates CHANGELOG.md by moving [Unreleased] content to version section

Extension Settings

Release Notes

0.0.1

Initial release of acme-portal

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines