git-tag-deploy 0.2.1

Dev tool to deploy git-tagged versions of a FastAPI app

Git Tag Deploy

A lightweight developer tool to deploy multiple Git-tagged versions of a FastAPI application simultaneously, each on its own dynamically assigned port. Includes a simple FastAPI endpoint to view all active deployments.

---

Features

• Deploy any number of Git tags from your repository.
• Automatically assigns free ports in the range 8001-9000.
• Each deployment runs in its own daemon process — terminates automatically when the main starter process exits.
• Provides a /deployments FastAPI endpoint to check which versions are running and on which ports.
• Simple CLI for one-command deployment.

---

Installation

Install via pip using the pypi package:

pip install git-tag-deploy

This installs the package and registers the git-tag-deploy CLI.

---

Usage

1. Ensure you have a deployment.yaml file in your repository, listing the apps and Git tags to deploy.
2. Run the CLI:

git-tag-deploy

The CLI will:

• Deploy all Git-tagged apps to dynamically assigned ports.
• Print the deployed apps and ports in the console.
• Start a FastAPI server on port 5000 to expose /deployments.

Example console output:

Starting deployments...

Deployments started:
 - service1: tag=v1.0.0, port=8001
 - service2: tag=v1.1.0, port=8002

FastAPI status server running at http://127.0.0.1:5000/deployments

Visit http://127.0.0.1:5000/deployments to see JSON information of all active deployments.

---

Project Structure

tenbatsu24-git-tag-deployment/
├── pyproject.toml        # Project configuration and dependencies
└── git_tag_deploy/       # Main package
    ├── __init__.py
    ├── cli.py            # CLI entry point
    ├── deployer.py       # Deployment logic and process management
    └── server.py         # FastAPI endpoint for deployment info

---

Dependencies

• Python 3.10+
• PyYAML – for reading deployment configuration
• FastAPI – for the status server
• uvicorn – ASGI server for deployed apps

---

How It Works

• Reads the deployment.yaml file to determine which Git tags to deploy.
• Clones the repository for each tag into a temporary directory.
• Starts each deployment in a daemonized process, running uvicorn on a free port.
• Tracks deployments in memory (tag + port) for the FastAPI /deployments endpoint.

---

Future Improvements

• Implement logging for deployment processes.
• Add health checks for deployed applications.
• Clean up temporary directories after deployments.
• Custom deployment scripts/hooks. (not just uvicorn app.main:app)
• Docker support for containerized deployments of git tags.

License

This project is licensed under the Apache-2.0 License. See the LICENSE file for details.