# Repository Backups

QuantEcon uses an automated backup system to protect our GitHub repositories. The backup workflow runs weekly and stores complete repository mirrors to AWS S3 for disaster recovery.

## Backup Repository

The backup infrastructure is managed in:

**[QuantEcon/workflow-backups](https://github.com/QuantEcon/workflow-backups)**

This repository contains:
- The backup automation scripts (Python)
- Configuration for which repositories to backup
- GitHub Actions workflow that runs weekly

## What Gets Backed Up

The backup creates complete git mirrors including:
- All branches
- All tags
- Full commit history
- GitHub issue metadata (optional)

## Viewing Backup Configuration

To see which repositories are currently being backed up, check the [`config.yml`](https://github.com/QuantEcon/workflow-backups/blob/main/config.yml) file in the workflow-backups repository.

The configuration supports:
- **Exact repository names**: Specific repos listed by name
- **Regex patterns**: Match multiple repos (e.g., `lecture-.*` backs up all lecture repositories)
- **Exclusions**: Repos or patterns to skip

Example configuration structure:

```yaml
backup:
  organization: "QuantEcon"
  repositories:
    - "my-important-repo"
  patterns:
    - "lecture-.*"
  exclude_repositories:
    - "testing-repo"
```

## Backup Schedule

Backups run automatically every week via GitHub Actions. The workflow can also be triggered manually from the [Actions tab](https://github.com/QuantEcon/workflow-backups/actions).

## More Information

For detailed setup instructions, CLI options, and restore procedures, see the [workflow-backups README](https://github.com/QuantEcon/workflow-backups#readme).