$ show ilyachch/django-rest-framework-rusdoc
This repository is a Russian-language translation mirror of the official Django REST Framework documentation. It does not contain any runnable application, API, or library code; the core content is a set of Markdown files mirroring the upstream DRF docs. The repo's functional value lies in its automation scripts and CI workflows that periodically check the upstream repository for changes, compare file hashes, and open pull requests to flag new or modified content that needs translation. The automation pipeline (`monitor_repository.py`, `commit_changes.py`) is a self-contained, reusable pattern for keeping translated documentation in sync with a source repository. The workflows (`check_source_for_changes.yml`, `check_all_temp_data_cleared.yml`) demonstrate practical GitHub Actions usage for doc-sync automation. The repository is not a software application in the traditional sense but a hybrid documentation project with a small but well-crafted automation component.
The LLM identified 3 files worth highlighting for reuse:
Core Python script that clones the upstream DRF repo, caches file hashes (MD5) and commit SHAs in `files_cache.json`, compares them with current state, copies new or changed files into a `.reference/` directory, and generates a `CHANGES.md` diff. This is a generic, reusable component for any translation or documentation project that needs to track and react to upstream changes. It is well-structured with dataclasses (`CacheData`, `FileStatus`, `GitChanges`) and isolated subprocess calls.
A helper script that reads the list of changed files from a `files_changed` file, pairs each modified translated file with its deleted original (from `.reference/`), and creates individual commits per pair with descriptive messages. This pattern ensures granular, traceable commits for translation updates and can be adapted to any project that requires pairing two file operations in version control.
A GitHub Actions workflow that runs weekly (cron schedule), executes `monitor_repository.py` and `commit_changes.py`, and if changes are detected, pushes a new branch (`sync-with-original`) and opens a pull request with the changes summary. This workflow is a self-contained, reusable pattern for automating documentation sync from an upstream source, including conflict detection and PR creation.