Skip to content

Add MAINTAINING.md - #53

Open
jeremyandrews wants to merge 2 commits into
mainfrom
docs/maintaining
Open

Add MAINTAINING.md#53
jeremyandrews wants to merge 2 commits into
mainfrom
docs/maintaining

Conversation

@jeremyandrews

Copy link
Copy Markdown
Member

This package's own maintenance facts: the single version source, the CI job list, the manual PyPI upload, the vendored Snowball stemmers, and the asset copy that nothing checks.

One fact, one place: anything true of more than one Scolta repo lives in scolta-core/MAINTAINING.md (tag1consulting/scolta-core#63), and this file links there instead of repeating it.

Where the repo contradicted the notes this was drafted from

  • The version does not live in two places. The notes said pyproject.toml and __version__ drift, so set both. pyproject.toml declares dynamic = ["version"] and reads src/scolta/__init__.py through [tool.hatch.version]; the comment above it says the point was to make drift impossible. Setting pyproject.toml is not a step.
  • Nothing publishes this package. The notes said a tag publishes through Trusted Publishing with pypa/gh-action-pypi-publish. There is no release workflow here at all: .github/workflows/ is ci.yml and ai-pr-review.yml. The upload is manual twine upload, and CI's dist job is the only gate in front of it. This is also listed as open in the shared guide.
  • There is no bundle parity check. The notes said this package has one modeled on Drupal's, fetching scolta-php through actions/checkout. It does not exist. What the test job does check out is scolta-core, for the prompt-text identity gate. The doc names the gap rather than describing it as covered.
  • The Amazee work is done. The notes said to port scolta-node's amazeeProvisioned branch. src/scolta/ai/amazee/ is implemented and this repo's CLAUDE.md says so.
  • Added, because it is the fact most likely to be broken by a well-meaning change: the Snowball stemmers under src/scolta/index/snowball/ are vendored rather than a dependency, because no published snowballstemmer release reproduces pagefind_stem byte for byte.

This repo has no pull-request template, so no template line was added; creating one just for this would be a different change.

What lives only here: the single version source, the CI job list, the manual
PyPI upload, the vendored Snowball stemmers, and the asset copy that nothing
checks.

The facts true of more than one Scolta repo stay in scolta-core's shared
MAINTAINING.md, RELEASING.md, REGRESSION.md and ASSETS.md; this file links
there rather than repeating them.
@github-actions

github-actions Bot commented Aug 14, 2026

Copy link
Copy Markdown

Summary

Adds MAINTAINING.md to the scolta-python repo, documenting maintainer-facing facts specific to this package: the single version source, CI job list, manual PyPI upload process, vendored Snowball stemmers, and the unchecked asset copy step. Repo-wide conventions are linked to scolta-core's shared docs rather than duplicated.

Type: docs
Effort: 1/5 — single new documentation file, no code changes

Walkthrough

File Change Summary
MAINTAINING.md Added New maintainer guide covering version location, PyPI publishing, CI checks, and asset/stemmer caveats

Related Issues & PRs

No related issues identified.


AI Review Summary — generated by ai-pr-review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Review: Approved

No findings above the confidence threshold. The changes look good.

Token usage by agent
Agent Model Input Output Cache Write Cache Read Total Est. Cost
code-reviewer Sonnet 5 6177 164 / 16384 1339 0 7680 $0.0260
Total 6177 164 1339 0 7680 $0.0260

AI Review — generated by ai-pr-review

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AI Review: Approved

No findings above the confidence threshold. The changes look good.

Token usage by agent
Agent Model Input Output Total Est. Cost
code-reviewer Sonnet 5 7001 67 / 16384 7068 $0.0220
Total 7001 67 7068 $0.0220

AI Review — generated by ai-pr-review

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.

1 participant