deployment and CI/CD | Pyjiit Docs

Two workflows. Docs on every push, Pages on main. PyPI on a published GitHub release (or manual dispatch).

Detail: Publishing to PyPI, GitHub Actions workflows.

flowchart TB
  subgraph docs [documentation.yml]
    Any["push / PR"] --> BuildDocs["sphinx-build"]
    BuildDocs --> Main{"main push?"}
    Main -->|yes| Pages["gh-pages"]
  end
  subgraph pypi [python-publish.yml]
    Rel["release published"] --> BuildPkg["poetry publish --build"]
    Disp["workflow_dispatch"] --> BuildPkg
  end

Secrets#

Secret	Workflow	Use
`GITHUB_TOKEN`	documentation	`peaceiris/actions-gh-pages`
`PYPI_API_KEY`	python-publish	`poetry config pypi-token.pypi`

No test job. No lint job.

Python on runners#

Both workflows pin Python 3.12. The package still claims requires-python = ">=3.9".

Version bump before a release#

pyproject.toml version
pyjiit/init.py __version__
docs/conf.py release
Tag / GitHub release

flowchart LR
  Bump["0.1.0a8 in three files"] --> Tag["GitHub release"]
  Tag --> Wheel["PyPI"]
  Push["push main"] --> Site["pyjiit.codelif.in"]