diff --git a/README_CHANGES.md b/README_CHANGES.md index 149ef8b..d070292 100644 --- a/README_CHANGES.md +++ b/README_CHANGES.md @@ -1,58 +1,112 @@ # Podcastrr - Forgejo Integration Changes -This document summarizes the changes made to integrate Podcastrr with Forgejo for CI/CD and container registry functionality. +This document summarizes the changes made to integrate Podcastrr with Forgejo for CI/CD and container registry functionality, including Forgejo Actions for automated workflows. ## Files Created -1. **`.drone.yml`** - - CI/CD pipeline configuration for Forgejo +### Forgejo Actions (New) + +1. **`.forgejo/workflows/build.yml`** + - CI/CD workflow configuration using Forgejo Actions + - Includes jobs for testing, building Docker images, and notifications + - Automatically builds and pushes Docker images on pushes to the main branch or tags + +2. **`.forgejo/workflows/demo.yaml`** + - Simple example workflow for Forgejo Actions + - Demonstrates basic functionality as described in the Forgejo Actions user guide + +3. **`README_ACTIONS.md`** + - Detailed guide for using Forgejo Actions with Podcastrr + - Includes explanations of workflow files, prerequisites, and troubleshooting tips + +### Previous Integration + +4. **`.drone.yml`** (Updated with comments about Forgejo Actions) + - Legacy CI/CD pipeline configuration for Forgejo using Drone CI - Includes steps for testing, building Docker images, and notifications - Automatically builds and pushes Docker images on pushes to the main branch -2. **`README_FORGEJO.md`** +5. **`README_FORGEJO.md`** (Updated with Forgejo Actions information) - Comprehensive guide for setting up and using Podcastrr with Forgejo - Includes instructions for repository setup, secrets configuration, and using the Docker image -3. **`docker-compose.override.yml.example`** +6. **`docker-compose.override.yml.example`** - Template for local customization of Docker Compose setup - Provides examples for development-specific settings ## Files Updated -1. **`.gitignore`** +### For Forgejo Actions + +1. **`.drone.yml`** + - Added comments explaining the transition to Forgejo Actions + - Kept for backward compatibility with existing Drone CI setups + +2. **`README_FORGEJO.md`** + - Updated to include information about Forgejo Actions + - Added sections on configuring secrets for Forgejo Actions + - Reorganized CI/CD pipeline section to prioritize Forgejo Actions + +### Previous Updates + +3. **`.gitignore`** - Added Docker-specific entries - Added common Python patterns -2. **`.env.example`** +4. **`.env.example`** - Updated for Docker compatibility (Linux-style paths) - Added Forgejo-specific configuration variables - Set production as the default environment -3. **`docker-compose.yml`** +5. **`docker-compose.yml`** - Made it more flexible for Forgejo integration - Added environment variable interpolation with defaults - Added commented options for using Forgejo registry ## Next Steps +### For Forgejo Actions (Recommended) + 1. **Set up your Forgejo repository** - Follow the instructions in `README_FORGEJO.md` -2. **Configure CI/CD secrets** - - Add the required secrets to your Forgejo repository settings +2. **Enable Forgejo Actions** + - Ensure "Enable Repository Actions" is checked in your repository settings + - See `README_ACTIONS.md` for detailed instructions + +3. **Configure Forgejo Actions secrets** + - Add the required secrets to your repository's Actions secrets: + - `FORGEJO_REGISTRY` + - `FORGEJO_USERNAME` + - `FORGEJO_PASSWORD` + +4. **Push to Forgejo** + - The Forgejo Actions workflows will automatically run + - View results in the Actions tab of your repository + +5. **Pull and run the Docker image** + - Use the commands in `README_FORGEJO.md` to pull and run your Docker image + +### For Drone CI (Legacy) + +1. **Configure Drone CI secrets** + - Add the required secrets to your Forgejo repository settings: + - `docker_username` + - `docker_password` + - `webhook_url` (optional) + +2. **Configure environment variables** + - Set up `DRONE_REGISTRY` in your Forgejo CI/CD settings 3. **Customize for your environment** - Copy `.env.example` to `.env` and update with your settings - Copy `docker-compose.override.yml.example` to `docker-compose.override.yml` for local customization -4. **Push to Forgejo** - - The CI/CD pipeline will automatically build and push your Docker image - -5. **Pull and run the Docker image** - - Use the commands in `README_FORGEJO.md` to pull and run your Docker image - ## Additional Information - The Docker image is built using the existing Dockerfile, which was already well-configured -- The CI/CD pipeline includes testing to ensure code quality -- The Docker Compose setup allows for both local development and production deployment \ No newline at end of file +- Both CI/CD approaches (Forgejo Actions and Drone CI) include testing to ensure code quality +- The Docker Compose setup allows for both local development and production deployment +- Forgejo Actions provides a more integrated experience with Forgejo and follows a syntax similar to GitHub Actions +- The demo workflow (.forgejo/workflows/demo.yaml) provides a simple starting point for understanding Forgejo Actions +- The comprehensive build workflow (.forgejo/workflows/build.yml) demonstrates a complete CI/CD pipeline using Forgejo Actions