Skip to content

Commit ae0c38b

Browse files
clean up content
1 parent 319d6da commit ae0c38b

4 files changed

Lines changed: 11 additions & 15 deletions

File tree

.github/workflows/release.yml

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
11
name: Release
22

3-
# Fires when a version tag is pushed (for example v0.2.1).
4-
# Builds hatchling wheel + sdist and a Windows PyInstaller zip, then attaches
5-
# all three as GitHub Release assets via softprops/action-gh-release.
3+
# v* tag push: build wheel, sdist, and Windows zip; publish attaches all three to the Release.
4+
# workflow_dispatch runs the build jobs only (no publish).
65
#
7-
# Expected asset names (version comes from pyproject.toml at the tagged commit):
6+
# Asset names (version from pyproject.toml at the tagged commit):
87
# cppa_cursor_browser-<version>-py3-none-any.whl (~154 KiB at 0.2.0)
9-
# cppa_cursor_browser-<version>.tar.gz (~225 KiB at 0.2.0)
10-
# CursorChatBrowser-windows.zip (PyInstaller onedir bundle)
8+
# cppa_cursor_browser-<version>.tar.gz (~225 KiB at 0.2.0)
9+
# CursorChatBrowser-windows.zip
1110
#
12-
# Fork verification: push a test tag (for example v0.0.0-test) and confirm the
13-
# workflow attaches all three files to the resulting Release.
14-
# workflow_dispatch runs build-python + build-windows only (publish is tag-only).
11+
# Fork check: push v0.0.0-test and confirm all three files on the Release.
1512

1613
on:
1714
push:
@@ -68,8 +65,7 @@ jobs:
6865
python-version: "3.12"
6966

7067
- name: Install runtime dependencies
71-
# Lock file for Flask/runtime deps; pywebview is the [desktop] extra and
72-
# is required so the published exe can open its native window.
68+
# requirements-lock.txt for runtime; pywebview for the desktop window.
7369
run: |
7470
python -m pip install --upgrade pip
7571
python -m pip install -r requirements-lock.txt

.github/workflows/tests.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ jobs:
120120
# ── PyInstaller desktop build (Windows only, once per workflow) ────────
121121
# Closes #44. Builds the onedir bundle and smoke-tests --help so the
122122
# desktop entry point is verified without launching the GUI window.
123-
# pywebview matches release.yml so CI bundles the same graph we ship.
123+
# pywebview matches release.yml so the Windows bundle matches what we ship.
124124
- name: Install pywebview for PyInstaller bundle
125125
if: matrix.os == 'windows-latest' && matrix.python-version == '3.12'
126126
run: python -m pip install 'pywebview>=5.0,<7'

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -265,15 +265,15 @@ Notable changes will be documented in **[CHANGELOG.md](CHANGELOG.md)** following
265265

266266
### GitHub Releases
267267

268-
Pushing a tag matching `v*` (for example `v0.2.1`) runs [`.github/workflows/release.yml`](.github/workflows/release.yml), which attaches three assets to the GitHub Release. Set `[project].version` in `pyproject.toml` to match the tag before you push (for example tag `v0.2.1` requires `version = "0.2.1"`); hatchling names the wheel and sdist from pyproject, not from the git tag.
268+
Push a `v*` tag (for example `v0.2.1`) to run [`.github/workflows/release.yml`](.github/workflows/release.yml). It uploads three assets to the GitHub Release. Set `[project].version` in `pyproject.toml` to match the tag before you push (`v0.2.1` needs `version = "0.2.1"`). Hatchling names the wheel and sdist from pyproject, not the git tag.
269269

270270
| Asset | Contents |
271271
|---|---|
272272
| `cppa_cursor_browser-<version>-py3-none-any.whl` | Installable wheel (hatchling build) |
273273
| `cppa_cursor_browser-<version>.tar.gz` | Source distribution |
274274
| `CursorChatBrowser-windows.zip` | Windows PyInstaller onedir bundle (`CursorChatBrowser.exe` plus supporting files) |
275275

276-
At `0.2.0`, local `python -m build` produced a ~154 KiB wheel and ~225 KiB sdist; the Windows zip size depends on the locked dependency tree at tag time. Copy release notes from the matching `[version]` section in `CHANGELOG.md` when publishing the GitHub Release.
276+
At `0.2.0`, a local `python -m build` gave a ~154 KiB wheel and ~225 KiB sdist. Windows zip size varies with the locked tree at tag time. Paste release notes from the matching `[version]` section in `CHANGELOG.md`.
277277

278278
When an API surface is scheduled for removal, follow the process in **[docs/API_DEPRECATION.md](docs/API_DEPRECATION.md)** (response headers, changelog entries, minimum notice period).
279279

cursor-browser.spec

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ a = Analysis(
1717
(str(src / "static"), "static"),
1818
],
1919
hiddenimports=[
20-
"webview", # pywebview must be installed at build time; hiddenimport alone is not enough
20+
"webview", # needs pywebview installed at build time
2121
"api.workspaces",
2222
"api.composers",
2323
"api.logs",

0 commit comments

Comments
 (0)