Skip to content

Commit f3eceae

Browse files
committed
Add release docs and CI for v1.0.0
1 parent 7cddf08 commit f3eceae

6 files changed

Lines changed: 249 additions & 178 deletions

File tree

.github/workflows/ci.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
branches: [main]
6+
push:
7+
branches: [main]
8+
9+
jobs:
10+
test-and-build:
11+
runs-on: macos-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Swift version
17+
run: swift --version
18+
19+
- name: Swift package tests
20+
run: swift test
21+
22+
- name: Build demo app (iOS Simulator)
23+
run: |
24+
xcodebuild \
25+
-project DemoApp/AssistantRuntimeDemoApp.xcodeproj \
26+
-scheme AssistantRuntimeDemoApp \
27+
-destination 'generic/platform=iOS Simulator' \
28+
CODE_SIGNING_ALLOWED=NO \
29+
build

CHANGELOG.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on Keep a Changelog and this project follows Semantic Versioning.
6+
7+
## [Unreleased]
8+
9+
## [1.0.0] - 2026-03-20
10+
11+
### Added
12+
13+
- Stable `CodexKit` + `CodexKitUI` runtime surface for iOS agent integration.
14+
- ChatGPT auth with `.deviceCode` and `.oauth` (localhost loopback callback flow).
15+
- Threaded runtime state restore, streaming output handling, and approval-gated tool execution.
16+
- Layered persona model (base instructions, thread persona stack, per-turn override).
17+
- Text + image user input support and assistant image attachment hydration.
18+
- Demo iOS app with:
19+
- dual auth flows
20+
- tool registration and logging
21+
- persona demos
22+
- Health Coach tab with HealthKit integration and proactive AI-generated coaching feedback
23+
- local reminder scheduling
24+
25+
### Changed
26+
27+
- Refactored demo app into smaller Swift files for clearer ownership and readability.
28+
- Updated README docs with production setup guidance and end-to-end examples.
29+
30+
[Unreleased]: https://github.com/timazed/CodexKit/compare/v1.0.0...HEAD
31+
[1.0.0]: https://github.com/timazed/CodexKit/releases/tag/v1.0.0

CONTRIBUTING.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing
2+
3+
Thanks for contributing to `CodexKit`.
4+
5+
## Local Setup
6+
7+
```sh
8+
swift package resolve
9+
swift test
10+
```
11+
12+
For demo app validation:
13+
14+
```sh
15+
xcodebuild -project DemoApp/AssistantRuntimeDemoApp.xcodeproj -scheme AssistantRuntimeDemoApp -destination 'generic/platform=iOS' build
16+
```
17+
18+
## Pull Requests
19+
20+
- Keep changes focused and scoped.
21+
- Add or update tests when behavior changes.
22+
- Update docs (`README.md`, `DemoApp/README.md`, `CHANGELOG.md`) for user-facing changes.
23+
- Ensure tests pass before opening a PR.
24+
25+
## Commit Messages
26+
27+
Use clear, imperative messages. Example:
28+
29+
- `Add thread-level persona cache invalidation`
30+
- `Fix OAuth sign-in cancel state reset`
31+
32+
## Releases
33+
34+
- We use Semantic Versioning with tags like `v1.0.0`.
35+
- Update `CHANGELOG.md` for release notes.
36+
- Tag from `main` with an annotated tag:
37+
38+
```sh
39+
git tag -a vX.Y.Z -m "Release vX.Y.Z"
40+
git push origin vX.Y.Z
41+
```

0 commit comments

Comments
 (0)