Skip to content

Document release publication, and align repository layout - #9

Merged
showxu merged 1 commit into
masterfrom
maintenance
Oct 4, 2026
Merged

showxu merged 1 commit into
masterfrom
maintenance

Conversation

@showxu

@showxu showxu commented Oct 4, 2026

Copy link
Copy Markdown
Contributor

Docs

  • .github/RELEASE.md moves to Documentation/Reference/Release.md, which now spells out the real publication flow: signed tag, commit-bound draft, release.yml promotion of both CI artifacts, publish. It names the credentials notify-catalog.yml actually reads (vars.CATALOG_APP_CLIENT_ID, secrets.CATALOG_APP_PRIVATE_KEY); the old text named CATALOG_DISPATCH_TOKEN.
  • New CHANGELOG.md covering 0.1.0 through 0.3.0, taken from the GitHub Releases. Removes Documentation/Reference/ReleaseNotes-0.2.1.md; the GitHub Release holds those notes.
  • The documentation index now lists the Architecture overview, State migration and Release pages. VersioningAndRelease.md links the changelog and the release guide.
  • README.md and Package.md state current facts instead of edit history. Public docs no longer point to .agent/. CONTRIBUTING.md lists the checks CI runs, and AGENTS.md follows the current canonical template.

CI

  • Renames validate.yml to ci.yml and upload-release.yml to release.yml; job names are unchanged. The release workflow's source-run check and Scripts/check-windows-artifact.ps1 now expect .github/workflows/ci.yml. After this merges, a release must come from a ci.yml run.
  • Adds .github/CODEOWNERS.

Code

  • Removes the unused optionalBoundedInt from CodexAppServerProvider.swift.

Validation: locally, version.py check, Package.resolved unchanged after resolve, import-schema.mjs --check, the schema-import node test, strict format lint, swift build --build-tests and 38 Python tests all pass.

The release and catalog notification guide moves from .github/RELEASE.md
to Documentation/Reference/Release.md. It now describes the actual
publication steps: tag, commit-bound draft, release.yml promotion of the
CI artifacts, and publish. It also names the credentials the notification
workflow reads, CATALOG_APP_CLIENT_ID and CATALOG_APP_PRIVATE_KEY.
CHANGELOG.md records the published releases, and the one-off 0.2.1
release notes page is removed because the GitHub Release holds them.

Workflows are renamed to ci.yml and release.yml with unchanged job names.
The release workflow and the Windows artifact check accept source runs
from ci.yml.

The unused optionalBoundedInt helper is removed. CODEOWNERS is added,
AGENTS.md follows the current canonical agent guide, CONTRIBUTING lists
the checks CI runs, the documentation index covers every page, and public
docs state current facts without edit history or local agent directories.
@showxu
showxu merged commit 8312588 into master Oct 4, 2026
8 checks passed
@showxu
showxu deleted the maintenance branch October 4, 2026 20:42
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