| ## Setup 1 – Standard Video Generation | |
| Generates videos using AI-based video generation with configurable captioning styles. | |
| ### Configuration Variables | |
| #### **CAPTION_STYLE** | |
| Defines the captioning/text style applied to generated videos. | |
| **Available values:** | |
| - `random` | |
| - `caption_1` | |
| - `caption_2` | |
| - `caption_3` | |
| - `caption_4` | |
| - `caption_style_on_screen_text` | |
| #### **CONTENT_STRATEGY_FILE** | |
| CSV file containing content strategy entries. | |
| - Must be placed in the **`data/`** directory | |
| - Example: | |
| ``` | |
| CONTENT_STRATEGY_FILE="content_strategies.csv" | |
| ``` | |
| - Full path: `data/content_strategies.csv` | |
| ### Running the Pipeline | |
| #### **Local Execution** | |
| ```bash | |
| python src/process_csv.py | |
| ``` | |
| The script reads the configured `CAPTION_STYLE` and `CONTENT_STRATEGY_FILE` and begins processing. | |
| #### **GitHub Actions Execution** | |
| The workflow triggers when a tag beginning with `run_wip` is pushed. | |
| **Single-job run:** | |
| ```bash | |
| git tag run_wip0 | |
| git push origin run_wip0 | |
| ``` | |
| **Parallel runs:** | |
| Format: `run_wip_<jobIndex>_<totalJobs>` | |
| Example for **job 0 out of 10 parallel jobs**: | |
| ```bash | |
| git tag run_wip_0_10 | |
| git push origin run_wip_0_10 | |
| ``` | |
| This ensures no two parallel jobs process the same CSV entries. | |
| ### Important Notes | |
| - Ensure all environment variables are set before running | |
| - A progress file is **automatically created** after each successful generation | |
| - **Do not manually edit** the progress file | |
| - Parallel execution relies on progress tracking and job index logic | |
| --- | |
| ## Common Elements Across All Setups | |
| ### Progress Tracking | |
| - Progress files are stored in the `data/` directory | |
| - Automatically created/updated after successful generation | |
| - Used to prevent duplicate processing in parallel runs | |
| - Should never be manually modified | |
| ### Parallel Execution | |
| - Uses tag format: `run_wip_<jobIndex>_<totalJobs>` | |
| - Job index starts at 0 | |
| - Each job processes a unique section of the CSV | |
| - Safe for concurrent execution without collisions | |
| ### Workflow Trigger | |
| All setups use the same GitHub Actions trigger: tags beginning with `run_wip` | |
| ### Environment Variable Configuration | |
| **For local execution:** Set variables in a `.env` file in the project root. | |
| **For GitHub Actions:** Set variables in the GitHub repository's **Variables** section (Settings → Secrets and variables → Actions → Variables). |