{"id":28409688,"url":"https://github.com/charming-byte/freetz-builder","last_synced_at":"2025-06-25T03:32:14.632Z","repository":{"id":297768660,"uuid":"997609235","full_name":"charming-byte/freetz-builder","owner":"charming-byte","description":"ci pipeline for freetz-ng builds","archived":false,"fork":false,"pushed_at":"2025-06-23T14:08:16.000Z","size":24,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-06-23T15:25:00.745Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/charming-byte.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-06T20:27:12.000Z","updated_at":"2025-06-23T13:24:35.000Z","dependencies_parsed_at":"2025-06-07T11:19:43.879Z","dependency_job_id":"12595e08-0e5f-4e4a-add2-3328d6bed784","html_url":"https://github.com/charming-byte/freetz-builder","commit_stats":null,"previous_names":["charming-byte/freetz-builder"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/charming-byte/freetz-builder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charming-byte%2Ffreetz-builder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charming-byte%2Ffreetz-builder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charming-byte%2Ffreetz-builder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charming-byte%2Ffreetz-builder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/charming-byte","download_url":"https://codeload.github.com/charming-byte/freetz-builder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charming-byte%2Ffreetz-builder/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261798232,"owners_count":23211138,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-06-02T09:44:04.356Z","updated_at":"2025-06-25T03:32:14.619Z","avatar_url":"https://github.com/charming-byte.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# freetz-builder\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](https://opensource.org/licenses/MIT)\n![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/charming-byte/freetz-builder/build.yml?style=flat-square\u0026label=Build%20Status)\n\nAutomated builder for Freetz-NG. I use this setup to automate custom firmware builds for freetz-ng.\nThis repo checks upstream changes, applies local configs, builds the firmware, renames artifacts with commit metadata, and notifies about build state updates either per telegram, mattermost or discord.\n\n## Table of Contents\n\n- [🚀 How to Use](#-how-to-use)\n  - [🛠️ Setup](#️-setup)\n  - [⚙️ Running Builds](#️-running-builds)\n  - [🔄 Customization](#-customization)\n  - [📦 Accessing Build Artifacts](#-accessing-build-artifacts)\n- [💻 Technologies and Tools](#-technologies-and-tools)\n- [📄 License](#-license)\n\n## 🚀 How to Use\n\n### 🛠️ Setup\n\n1. **Fork or clone this repository** to your own GitHub account.\n\n2. **Configure GitHub Secrets** for notifications (optional):\n   - `TELEGRAM_TOKEN` and `TELEGRAM_CHAT_ID`: For Telegram notifications\n   - `DISCORD_WEBHOOK`: For Discord notifications\n   - `MATTERMOST_WEBHOOK`: For Mattermost notifications\n\n3. **Configure Workflow permissions**\n    - Ensure that your Workflow permissions are set to `Read and write permissions`\n\n3. **Add your custom configurations**:\n   - Place your Freetz-NG `.config` file in the [`configs/`](./configs/) directory named as `my-box.config`\n\n### ⚙️ Running Builds\n\nThe build process can be triggered in two ways:\n\n1. **Scheduled Builds**: The workflow runs automatically at 2:00 AM UTC daily, checking for upstream changes and building if necessary.\n\n2. **Manual Builds**: You can trigger a build manually through the GitHub Actions interface using the \"workflow_dispatch\" event.\n\n### 🔄 Customization\n\n1. **Modify build parameters** in the `build.sh` script to adjust how the firmware is built.\n\n2. **Self-hosted runners**: The workflow is configured to run on self-hosted runners. Make sure your runner has sufficient resources for building firmware images.\n\n### 📦 Accessing Build Artifacts\n\nAfter a successful build:\n\n1. Navigate to the Actions tab in your GitHub repository\n2. Select the completed workflow run\n3. Download the firmware artifact which contains the `.image` files\n\nThe firmware files are automatically named with commit metadata, making them easy to identify and trace back to specific builds.\n\n## 💻 Technologies and Tools\n\n* [Freetz-NG](https://github.com/Freetz-NG/freetz-ng): Framework for building custom firmware images for AVM FRITZ!Box devices.\n* [GitHub Actions](https://github.com/features/actions): Automates the pull, build, and push steps via CI.\n* Webhook Notifications: Optional real-time notifications integrated using POST hooks to services like:\n  * [Telegram Bot API](https://core.telegram.org/bots/api)\n  * [Discord Webhooks](https://discord.com/developers/docs/resources/webhook)\n  * [Mattermost Incoming Webhooks](https://developers.mattermost.com/integrate/webhooks/incoming/)\n\n## 📄 License\n\nThis project is licensed under the MIT License - see [LICENSE](LICENSE) for more details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharming-byte%2Ffreetz-builder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharming-byte%2Ffreetz-builder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharming-byte%2Ffreetz-builder/lists"}