|
| 1 | +# cupertino-rel |
| 2 | + |
| 3 | +Release automation tool for Cupertino maintainers. |
| 4 | + |
| 5 | +## Synopsis |
| 6 | + |
| 7 | +```bash |
| 8 | +cupertino-rel [options] [subcommand] |
| 9 | +``` |
| 10 | + |
| 11 | +## Options |
| 12 | + |
| 13 | +| Option | Description | |
| 14 | +|--------|-------------| |
| 15 | +| [--version](option (--)/version.md) | Show version information | |
| 16 | +| -h, --help | Show help information | |
| 17 | + |
| 18 | +## Description |
| 19 | + |
| 20 | +Automates the complete Cupertino release workflow: |
| 21 | + |
| 22 | +1. Update version in `Constants.swift`, `README.md`, `CHANGELOG.md` |
| 23 | +2. Commit version bump |
| 24 | +3. Create and push git tag |
| 25 | +4. Wait for GitHub Actions to build |
| 26 | +5. Upload databases via `cupertino release` |
| 27 | +6. Update Homebrew formula |
| 28 | + |
| 29 | +## Requirements |
| 30 | + |
| 31 | +- `GITHUB_TOKEN` environment variable with `repo` scope |
| 32 | + |
| 33 | +## Subcommands |
| 34 | + |
| 35 | +| Subcommand | Description | |
| 36 | +|------------|-------------| |
| 37 | +| `full` | Run the complete release workflow (default) | |
| 38 | +| `bump` | Bump version in all required files | |
| 39 | +| `tag` | Commit changes and create git tag | |
| 40 | +| `databases` | Package and upload databases to GitHub Releases | |
| 41 | +| `homebrew` | Update Homebrew formula with new version | |
| 42 | +| `docs-update` | Update documentation databases and bump minor version | |
| 43 | + |
| 44 | +## Usage |
| 45 | + |
| 46 | +### Full Release |
| 47 | + |
| 48 | +```bash |
| 49 | +# Run complete release workflow (major/minor/patch) |
| 50 | +cupertino-rel full --bump-type patch |
| 51 | +cupertino-rel full --bump-type minor |
| 52 | +cupertino-rel full --bump-type major |
| 53 | +``` |
| 54 | + |
| 55 | +### Individual Steps |
| 56 | + |
| 57 | +```bash |
| 58 | +# Bump version only |
| 59 | +cupertino-rel bump --type patch |
| 60 | + |
| 61 | +# Create and push tag |
| 62 | +cupertino-rel tag |
| 63 | + |
| 64 | +# Upload databases |
| 65 | +cupertino-rel databases |
| 66 | + |
| 67 | +# Update Homebrew formula |
| 68 | +cupertino-rel homebrew |
| 69 | +``` |
| 70 | + |
| 71 | +### Documentation Update |
| 72 | + |
| 73 | +```bash |
| 74 | +# Update docs databases and bump minor version |
| 75 | +cupertino-rel docs-update |
| 76 | +``` |
| 77 | + |
| 78 | +## Version Bump Locations |
| 79 | + |
| 80 | +The `bump` command updates version in: |
| 81 | + |
| 82 | +- `Sources/Shared/Constants.swift` - App version constant |
| 83 | +- `README.md` - Version badge and references |
| 84 | +- `CHANGELOG.md` - New version section |
| 85 | + |
| 86 | +## See Also |
| 87 | + |
| 88 | +- [DEVELOPMENT.md](../../../DEVELOPMENT.md) - Development workflow |
| 89 | +- [DEPLOYMENT.md](../DEPLOYMENT.md) - Deployment and CI/CD |
0 commit comments