Skip to content

chore: launch-prep hygiene for public repo#117

Merged
saagpatel merged 2 commits into
mainfrom
chore/launch-prep-hygiene
Jun 21, 2026
Merged

chore: launch-prep hygiene for public repo#117
saagpatel merged 2 commits into
mainfrom
chore/launch-prep-hygiene

Conversation

@saagpatel

Copy link
Copy Markdown
Owner

Launch-prep public hygiene pass.

  • Align fallback_version with the published release line; note the changelog versioning re-base
  • Remove a CI proof artifact and stale dev screenshots from the repo root; gitignore them
  • Stop tracking the maintainer handoff file
  • Demo docs: replace hardcoded dated output filenames with evergreen glob patterns
  • CI workflow: default username placeholder instead of a hardcoded account; add Python 3.12 to the test matrix
  • Bump package maturity classifier to Beta; minor README copy fixes

Flagged for maintainer (not changed): the console-script entry point uses a bare src package path that may not resolve on a non-editable PyPI install — worth verifying with a clean install.

- fix: set setuptools-scm fallback_version to 0.1.4 (matches latest
  PyPI/GitHub tag); was incorrectly set to 0.19.0 (internal dev series)
- docs: add versioning note to CHANGELOG.md explaining the 0.x.0
  internal history vs the public 0.1.x PyPI line
- chore: git rm proof-pr.json (CI artifact, not project source)
- chore: git rm sprint13-*.png (unreferenced dev screenshots)
- chore: add proof-pr.json and sprint*.png to .gitignore
- fix: audit.yml username input default changed from hardcoded owner
  account to empty string; remove || fallbacks in run blocks
- ci: expand Python matrix to include 3.12 alongside 3.11
- fix: Development Status classifier bumped from Alpha to Beta
- docs: replace hardcoded dated filenames in README demo section with
  generic glob patterns
- docs: replace literal <name> placeholder in workbook-signoff example
  with 'yourname'
- docs: remove emoji from README case-study line

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 9b2952398a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread .github/workflows/audit.yml Outdated
…lback

`workflow_dispatch` with no username input produced an empty USERNAME,
causing `audit ""` to hit `/users//repos` and build a blank handoff
title. Add `|| 'saagpatel'` fallback to all three USERNAME assignments
so a bare "Run workflow" click audits the canonical owner rather than
failing silently.

Fixes test_packaging.py assertion and addresses P2 review comment on PR #117.
@saagpatel

Copy link
Copy Markdown
Owner Author

Re: the flagged src.cli:main entry point — verified working. A clean-room isolated install of the published package (uvx --from github-repo-auditor audit --help) runs successfully (exit 0, full usage printed), so the console script resolves correctly for real pip install users.

Latent risk (not a blocker, recommend as a follow-up): the package ships a generically-named top-level src import package, which is why src.cli resolves. It works today but risks a namespace collision with any other installed package that also ships a top-level src. Recommended future refactor: rename the package dir src/github_repo_auditor/ and update the entry point to github_repo_auditor.cli:main. Out of scope for this hygiene PR (it's a broader refactor on an actively-developed repo).

@saagpatel saagpatel merged commit 023d448 into main Jun 21, 2026
4 checks passed
@saagpatel saagpatel deleted the chore/launch-prep-hygiene branch June 21, 2026 03:26
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