Skip to content

Switch install docs to PyPI after 2.3.0 - #51

Merged
RFingAdam merged 3 commits into
mainfrom
cursor/docs-pypi-install-9050
Nov 4, 2026
Merged

RFingAdam merged 3 commits into
mainfrom
cursor/docs-pypi-install-9050

Conversation

@RFingAdam

Copy link
Copy Markdown
Owner

Summary

lineforge 2.3.0 is published on pypi.org/project/lineforge under the name lineforge. This updates the install path from a GitHub URL to pip install lineforge.

  • README, Quick Start, the MCP example, docs home, and MIGRATION.md now install from PyPI, with extras ([gui], [dev]) and clone instructions kept for development / the web GUI frontend.
  • Added a PyPI version badge (resolves at https://img.shields.io/pypi/v/lineforge.svg).
  • Added a short Releasing section (README + docs home + mkdocs nav) pointing at docs/release/PYPI_TRUSTED_PUBLISHER.md.
  • .github/workflows/release.yml already publishes via OIDC trusted publishing (id-token: write, pypi environment, no API token). Left unchanged.

Closes #49.

Acceptance criteria

  • README and docs install instructions use pip install lineforge; no remaining "not published on PyPI" text for the current package.
  • PyPI badge added and resolves.
  • release.yml verified as trusted publishing — no long-lived PyPI token required.
  • Docs build (docs.yml) and CI pass.

Out of scope

No code, solver, dependency, version, tag, or release changes. #16 / #41 / #46 are left to their own PRs.

Open in Web Open in Cursor 

lineforge 2.3.0 is published on pypi.org as lineforge. Point README,
Quick Start, the MCP example, and MIGRATION.md at pip install lineforge,
add a PyPI version badge, and document the trusted-publisher release path.
…all-9050

Keep PyPI install docs from this branch and the Unreleased security notes from main (#41, #46).
The previous CI run cancelled Test (macos-latest / py3.12) before any steps ran. This empty commit retriggers the suite; no code change.
@RFingAdam
RFingAdam merged commit e62a13d into main Nov 4, 2026
13 checks passed
@RFingAdam RFingAdam mentioned this pull request Nov 4, 2026
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Release follow-through: switch install docs to PyPI after 2.3.0 publishes

1 participant