codeship/heroku-deployment

Heroku Docker部署镜像

概述

该镜像是一款专为简化应用部署流程设计的工具，旨在通过Docker容器实现向Heroku平台的无缝部署。它集成了Heroku部署所需的认证、配置兼容及命令执行逻辑，帮助开发者减少手动配置步骤，提高部署效率与一致性。

核心功能与特性

• 自动认证管理：内置Heroku容器注册表（Heroku Container Registry）认证流程，无需手动执行heroku container:login
• 配置兼容性处理：自动检测并调整Dockerfile与Heroku平台的兼容性（如端口映射、进程类型声明等）
• 环境变量集成：支持通过环境变量注入Heroku应用配置、API密钥等敏感信息
• 部署流程自动化：整合构建、推送、发布全流程，一键完成从本地镜像到Heroku应用的部署

使用场景与适用范围

• 开发者日常部署：适合需要频繁将应用部署到Heroku的开发者，简化命令行操作
• CI/CD流程集成：可嵌入持续集成/持续部署流水线（如GitHub Actions、GitLab CI等），实现代码提交后的自动部署
• 多环境管理：支持针对开发、测试、生产等不同Heroku应用环境进行差异化部署
• 环境一致性保障：通过Docker容器确保本地开发环境与Heroku部署环境的配置一致性

使用方法与配置说明

前提条件

• 本地已安装Docker Engine（20.10+版本）
• 已创建Heroku账户及目标应用（通过heroku create或Heroku Dashboard）
• 已获取Heroku API密钥（在Heroku账户设置 > "API密钥" 中查看）
• 本地项目已包含符合Heroku规范的Dockerfile（建议基于Heroku官方基础镜像构建）

基本部署步骤

1. 拉取镜像

bash
docker pull [镜像名称]  # 请替换为实际镜像名称（如heroku-deploy:latest）

2. 配置部署参数

创建环境变量配置文件（如.env），填入必要参数：

env
# 必选参数
HEROKU_API_KEY=your_heroku_account_api_key  # Heroku账户API密钥
APP_NAME=your_heroku_app_name               # 目标Heroku应用名称（需提前创建）

# 可选参数
DOCKERFILE_PATH=./path/to/Dockerfile        # 本地Dockerfile路径（默认：./Dockerfile）
HEROKU_REGISTRY=registry.heroku.com         # Heroku容器注册表地址（默认：registry.heroku.com）
DEPLOY_TIMEOUT=300                          # 部署超时时间（秒，默认：300）
VERBOSE=true                                # 是否输出详细日志（默认：false）

3. 执行部署

通过以下命令运行容器并触发部署流程：

bash
docker run --rm \
  -v $(pwd):/app \          # 挂载本地项目目录到容器内/app路径
  --env-file .env \         # 加载环境变量配置文件
  [镜像名称] \              # 替换为实际镜像名称
  deploy                    # 执行部署命令（镜像内置部署脚本入口）

Docker Compose配置示例

yaml
version: '3.8'
services:
  heroku-deploy:
    image: [镜像名称]  # 替换为实际镜像名称
    volumes:
      - ./:/app       # 挂载本地项目目录
    environment:
      - HEROKU_API_KEY=your_heroku_api_key
      - APP_NAME=your_heroku_app_name
      - DOCKERFILE_PATH=./Dockerfile
      - VERBOSE=true
    command: deploy   # 执行部署命令

配置参数说明

注意事项

• Dockerfile兼容性：确保Dockerfile中声明的端口与Heroku动态分配端口兼容（建议使用ENV PORT=8080并监听该端口，Heroku会通过$PORT环境变量注入实际端口）
• 敏感信息保护：HEROKU_API_KEY属于敏感凭证，建议通过环境变量或密钥管理工具传递，避免硬编码在配置文件中
• 部署验证：部署完成后可通过heroku logs --app [APP_NAME]查看应用日志，验证部署结果
• 版本控制：建议通过标签（如:v1.0.0）指定镜像版本，避免因镜像更新导致部署行为变更