Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,20 @@ directory and lets you toggle which ones are tracked.

## Installation

Prerequisites:
### Python (pipx)

- Python `>=3.13`
- `uv`

Setup:
Requires Python `>=3.13`.

```bash
uv sync --dev
pipx install mr-manager
```

Run:
### From source

Prerequisites: Python `>=3.13`, `uv`

```bash
uv sync --dev
uv run mr-manager
```

Expand Down Expand Up @@ -80,3 +80,4 @@ via CI.
- [Wiki Home](https://github.com/mowi12/mr-manager/wiki)
- [Contribution Guidelines](https://github.com/mowi12/mr-manager/wiki/Contribution-Guidelines)
- [Troubleshooting](https://github.com/mowi12/mr-manager/wiki/Troubleshooting)
- [Release Process](https://github.com/mowi12/mr-manager/wiki/Release-Process)
1 change: 1 addition & 0 deletions markdownlint.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"tables": false
},
"first-line-heading": false,
"no-duplicate-heading": false,
"table-column-style": "aligned",
"no-inline-html": {
"allowed_elements": ["div", "picture", "img", "a", "h1"]
Expand Down
9 changes: 9 additions & 0 deletions wiki/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ toggle which ones should be tracked.

- [Contribution Guidelines](https://github.com/mowi12/mr-manager/wiki/Contribution-Guidelines)
- [Troubleshooting](https://github.com/mowi12/mr-manager/wiki/Troubleshooting)
- [Release Process](https://github.com/mowi12/mr-manager/wiki/Release-Process)

## What the app does

Expand All @@ -25,3 +26,11 @@ toggle which ones should be tracked.
- `k`: Move up
- `s`: Save changes
- `q`: Quit (with unsaved-changes confirmation when needed)

## Installation

| Channel | Command |
|---------------|---------------------------|
| Python (pipx) | `pipx install mr-manager` |

See the [README](https://github.com/mowi12/mr-manager#installation) for full installation instructions per channel.
Comment thread
mowi12 marked this conversation as resolved.
52 changes: 52 additions & 0 deletions wiki/Release-Process.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Release Process

Releases are fully automated via GitHub Actions. Pushing a version tag is the only manual step required.

## Versioning

This project uses [Semantic Versioning](https://semver.org/).
Versions are derived automatically from git tags via `hatch-vcs` — there is no version field to update manually.

Tag format: `vX.Y.Z` (e.g. `v1.2.0`)

## Releasing a new version

```bash
git tag vX.Y.Z
git push origin vX.Y.Z
```

That's it. The CI pipeline takes over from here.

## What CI does

Pushing a tag triggers the release workflow (`.github/workflows/release.yml`), which runs the following in order:

`git tag` → CI Pipeline → Build Artifacts → Publish to All Channels

### PyPI
Comment thread
mowi12 marked this conversation as resolved.

Builds a wheel and sdist via `uv build`, publishes via `uv publish` using OIDC trusted publishing (no token required).

## Required secrets

| Secret | Used for | Where to configure |
|-----------------|--------------|---------------------------------|
| *(none — OIDC)* | PyPI publish | PyPI trusted publisher settings |

## Verifying a release

After the workflow completes, confirm the new version is available on each channel:
Comment thread
mowi12 marked this conversation as resolved.

### PyPI

```bash
pipx install mr-manager==X.Y.Z
```

## Troubleshooting

### PyPI Publish Failed

Check the Actions log for OIDC errors. Confirm the trusted publisher is configured correctly on pypi.org
(owner, repo, workflow filename, and environment name must all match exactly).
1 change: 1 addition & 0 deletions wiki/_Sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@
- [Home](https://github.com/mowi12/mr-manager/wiki)
- [Contribution Guidelines](https://github.com/mowi12/mr-manager/wiki/Contribution-Guidelines)
- [Troubleshooting](https://github.com/mowi12/mr-manager/wiki/Troubleshooting)
- [Release Process](https://github.com/mowi12/mr-manager/wiki/Release-Process)