From 3a2e5af0c685de4456de5795d9a9138c439fc132 Mon Sep 17 00:00:00 2001 From: motive Date: Sun, 6 Apr 2025 14:02:58 -0400 Subject: [PATCH] add README --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..2079184 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Actions Sync for OpenWoW + +This repository automates the synchronization of public GitHub Actions to this GitHub instance hosted at `https://openwow.dev` using the [`actions/actions-sync`](https://github.com/actions/actions-sync) tool. + +## How it Works + +The synchronization is handled by the GitHub Actions workflow defined in `.github/workflows/actions-sync.yaml`. + +1. **Trigger:** The workflow runs automatically: + * On a schedule (daily at 00:00 UTC). + * On pushes to the `master` branch. + * Manually via `workflow_dispatch`. +2. **Setup:** The workflow checks out this repository and downloads the `actions-sync` binary. +3. **Sync:** It reads the list of target repositories from `mirrored-repositories.txt` and uses `actions-sync` to mirror them to the `https://openwow.dev` GitHub instance. + +## Configuration + +* **Repositories to Sync:** Add or remove repository names (in `owner/repo` format, one per line) in the `mirrored-repositories.txt` file.