zodiak-deployment

Document deployment and configuration procedures for the Zodiak service on Fly.io.

Updated Sep 22, 2023
One-click install
npx skills add https://github.com/gantelo/zodiak --skill zodiak-deployment
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: zodiak-deployment
Source: https://github.com/gantelo/zodiak/tree/main/.cursor/skills/zodiak-deployment
Command: npx skills add https://github.com/gantelo/zodiak --skill zodiak-deployment

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides comprehensive documentation and guidance for deploying, configuring, and managing the Zodiak service, ensuring smooth operation and maintainability.

Core Features & Use Cases

  • Deployment Guidance: Details on using Fly.io for hosting, including fly.toml configuration.
  • Environment Variable Management: Lists all necessary environment variables and their purpose, with instructions for local development using .env files.
  • CI/CD Automation: Explains GitHub Actions workflows for deployment (fly.yml) and scheduled tasks (prompts-schedule.yml).
  • Use Case: A new developer joins the project and needs to understand how to deploy the Zodiak bot to Fly.io, including setting up the necessary API keys and environment variables.

Quick Start

Consult the README.md file for initial setup and deployment instructions.

Frequently Asked Questions about zodiak-deployment

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I deploy a service to Fly.io using GitHub Actions CI/CD workflows?

To deploy a service to Fly.io using GitHub Actions, you configure a `fly.yml` workflow file that automates the deployment process alongside a `fly.toml` file to define your hosting setup. This Skill documents those exact procedures for the Zodiak service.

What environment variables do I need to configure for local development with .env files?

Configuring environment variables for local development requires listing necessary API keys and settings within a `.env` file to mirror the production environment. This Skill provides a comprehensive list of required environment variables and their specific purposes.

Can I automate scheduled tasks and deployments using GitHub Actions workflows?

Yes, you can automate scheduled tasks and deployments using GitHub Actions by configuring specific workflow files like `prompts-schedule.yml` for cron tasks and `fly.yml` for CI/CD deployment. This Skill documents how to set up these automated workflows for the Zodiak application.

Does the Zodiak deployment process support Fly.io hosting and configuration?

The Zodiak deployment process fully supports Fly.io hosting and configuration by utilizing a `fly.toml` file to manage the operational environment. This Skill details the setup and maintenance required to host the Zodiak service on Fly.io.

Why do I need to set up API keys and environment variables before deploying my bot?

You need to set up API keys and environment variables before deploying your bot to ensure the application operates securely and maintains access to required external services. This Skill outlines the necessary environment variable management for a smooth deployment.

What is the best way to manage configuration for a Fly.io deployment across different environments?

The best way to manage configuration across different environments is by separating local development `.env` files from production environment variables configured directly on Fly.io. This Skill documents how to maintain and update these configurations effectively.