PUBLISHING.MD

Publishing Checklist (GitHub)

1. Pre-publish safety checks

1. Confirm local-only constraints are documented in AGENTS.MD and README.MD.
2. Confirm only config.example.toml is tracked (no machine-specific config).
3. Confirm temp/cache/test runtime folders are ignored by .gitignore.
4. Confirm release version is updated in pyproject.toml.
5. Confirm CHANGELOG.MD contains a section for the release version.

2. Prepare repository

Run from project root:

git init
git add .
git status

Review staged files and ensure the following are NOT staged:

• config.toml
• config2.toml
• .idea/
• __pycache__/
• local runtime folders (logs/, backups/, sync/, state/, .tmp*)

3. First commit

git commit -m "chore: prepare codexSync MVP for GitHub publication"

4. Connect GitHub remote and push

git branch -M main
git remote add origin <YOUR_GITHUB_REPO_URL>
git push -u origin main

5. Verify after push

1. Open repository on GitHub.
2. Confirm CI workflow CI is running in Actions for both windows-latest and macos-latest.
3. Confirm README renders correctly.
4. Confirm no local/private files were uploaded.

6. Build and publish Windows .exe

Local build smoke test

python -m pip install --upgrade pip
pip install pyinstaller
pyinstaller --clean --noconfirm codexsync.spec
dist\codexsync.exe -h

GitHub automatic release assets

• Workflow: .github/workflows/release-exe.yml
• Trigger:
  • push tag v* (for example v0.1.3)
  • manual workflow_dispatch with input release_tag (for existing tag, for example v0.1.2)
• Output assets:
  • codexsync-<tag>-windows-amd64.zip
  • codexsync-<tag>-windows-amd64.zip.sha256

Create and push release tag:

git tag v0.1.2
git push origin v0.1.2