Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
motive committed Apr 6, 2025
1 parent d8e1fcf commit 3a2e5af
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 3a2e5af

Please sign in to comment.