Skip to main content

A CLI tool to automate QA deployments for forge environments

Project description

Forge Deploy

A CLI tool to automate QA deployments for forge environments.

Installation

From PyPI (Recommended)

pip install forge-deploy

From Source

git clone https://github.com/mayank-hiver/forge-deploy.git
cd forge-deploy
pip install -e .

Configuration

Create a forge-deploy.yml file in ~/.config/:

github:
  token: "your_github_token_here" 

local:
  qa_env_path: "/path/to/your/qa-env"

GitHub Token Setup

  1. Go to GitHub Settings → Developer settings → Personal access tokens
  2. Create a new token with these permissions:
    • repo (Full control of private repositories)
    • actions:read (Read access to actions)
  3. Copy the token to your config file

Usage

Basic Usage

forge-deploy --branch qa-feature-xyz --env hot-1

Options

  • --branch, -b: QA branch name (required)
  • --env, -e: Environment to deploy to (e.g., hot-1, hot-2, hot-3) (required)
  • --config, -c: Path to config file (default: config.yml)

Example Workflow

  1. Push your changes to a QA branch (e.g., qa-feature-xyz)
  2. Run the tool:
    forge-deploy -b qa-feature-xyz -e hot-1
    
  3. The tool will:
    • Monitor the "qa build" GitHub Action
    • Extract the generated tag
    • Update the qa-env environment file with the new tag
    • Show you the diff and ask for confirmation (skips if tag already latest)
    • Push changes to main
    • Monitor the "spawn changed/new areas" action
    • Report when deployment is complete

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

forge_deploy-0.1.0.tar.gz (8.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

forge_deploy-0.1.0-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

Details for the file forge_deploy-0.1.0.tar.gz.

File metadata

  • Download URL: forge_deploy-0.1.0.tar.gz
  • Upload date:
  • Size: 8.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for forge_deploy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 cb425abbfb92f3814c003f90355d3f93940925e509ae31572307e20af2e9267c
MD5 1b77e29ed622b97af4cbc84bf602f7fb
BLAKE2b-256 d36948f432a0c4886fefeb0f13d89091db6b7dd3713720e6173e03da71a48181

See more details on using hashes here.

File details

Details for the file forge_deploy-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: forge_deploy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.6

File hashes

Hashes for forge_deploy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef261e09edeae0ad7f61048bb729cb543277cd5e482f067d5f531263be48512b
MD5 e28e6863098f700f7ed88dd8a8581450
BLAKE2b-256 aa0e40f6bb79234809aff4b43beb72cc85917ae52475ce92b45b534bf2f0e681

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page