# Releasing `research-capacitor`

This repo is configured for PyPI trusted publishing through GitHub Actions.

## One-time setup

1. In PyPI, create a new pending publisher for project `research-capacitor`.
2. Use these values:
   - Owner: `t0mCS`
   - Repository name: `Compute-Capacitor`
   - Workflow name: `publish-pypi.yml`
   - Environment name: `pypi`
3. In GitHub, keep the workflow file at `.github/workflows/publish-pypi.yml`.

## Release checklist

1. Update the version in `pyproject.toml`.
2. Update the version in `src/rc/__init__.py`.
3. Commit the release changes.
4. Create and push a version tag:

```bash
git tag v0.1.0
git push origin v0.1.0
```

5. GitHub Actions will build the package, verify the distributions, and publish to PyPI.
6. Validate the released CLI:

```bash
pipx install research-capacitor
rc --help
```

## Manual trigger

You can also run the `Publish to PyPI` workflow manually from the GitHub Actions tab after the trusted publisher is configured.
