Skip to content

Commit f752bc0

Browse files
author
Hoa Dang DNA PC
committed
Improve release packaging and non-coder install flow
1 parent 2f67bbd commit f752bc0

15 files changed

Lines changed: 227 additions & 17 deletions

.github/workflows/ci.yml

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,23 @@ jobs:
3939
run: |
4040
bash ./scripts/install-skills.sh --destination ./.tmp/skills --force
4141
test -f ./.tmp/skills/codexkit-execution-planner/SKILL.md
42-
test "$(find ./.tmp/skills -mindepth 1 -maxdepth 1 -type d | wc -l)" -eq 9
42+
expected="$(find ./skills -mindepth 1 -maxdepth 1 -type d | wc -l)"
43+
actual="$(find ./.tmp/skills -mindepth 1 -maxdepth 1 -type d | wc -l)"
44+
test "$actual" -eq "$expected"
45+
bash ./scripts/quick-start.sh --starter project-management-office --destination ./.tmp/pmo --force
46+
test -f ./.tmp/pmo/README.md
4347
4448
- name: Smoke install on Windows
4549
if: runner.os == 'Windows'
4650
shell: pwsh
4751
run: |
4852
./scripts/install-skills.ps1 -Destination .\.tmp\skills -Force
4953
if (-not (Test-Path .\.tmp\skills\codexkit-execution-planner\SKILL.md)) { throw "Missing installed skill." }
50-
$count = (Get-ChildItem .\.tmp\skills -Directory).Count
51-
if ($count -ne 9) { throw "Expected 9 installed skills, got $count." }
54+
$expected = (Get-ChildItem .\skills -Directory).Count
55+
$actual = (Get-ChildItem .\.tmp\skills -Directory).Count
56+
if ($actual -ne $expected) { throw "Expected $expected installed skills, got $actual." }
57+
./scripts/quick-start.ps1 -Starter project-management-office -Destination .\.tmp\pmo -Force
58+
if (-not (Test-Path .\.tmp\pmo\README.md)) { throw "Missing scaffolded workspace." }
5259
5360
docs:
5461
name: Docs Build

.github/workflows/release.yml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,18 +34,18 @@ jobs:
3434
- name: Package release assets
3535
run: |
3636
git archive --format=zip --output "codexkit-source-${GITHUB_REF_NAME}.zip" HEAD
37-
mkdir -p release/codexkit-skill-pack
38-
cp -R skills scripts release/codexkit-skill-pack/
39-
cp README.md LICENSE NOTICE.md release/codexkit-skill-pack/
37+
mkdir -p release/codexkit-starter-pack
38+
cp -R skills templates workspaces playbooks automations mcp scripts release/codexkit-starter-pack/
39+
cp README.md LICENSE NOTICE.md START-HERE-WINDOWS.cmd START-HERE.sh CREATE-WORKSPACE-WINDOWS.cmd CREATE-WORKSPACE.sh release/codexkit-starter-pack/
4040
cd release
41-
zip -r "../codexkit-skill-pack-${GITHUB_REF_NAME}.zip" codexkit-skill-pack
41+
zip -r "../codexkit-starter-pack-${GITHUB_REF_NAME}.zip" codexkit-starter-pack
4242
4343
- name: Publish GitHub release
4444
env:
4545
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
4646
run: |
4747
gh release create "$GITHUB_REF_NAME" \
4848
"codexkit-source-${GITHUB_REF_NAME}.zip" \
49-
"codexkit-skill-pack-${GITHUB_REF_NAME}.zip" \
49+
"codexkit-starter-pack-${GITHUB_REF_NAME}.zip" \
5050
--generate-notes \
5151
--verify-tag

CHANGELOG.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
77

88
## [Unreleased]
99

10+
## [0.3.1] - 2026-03-20
11+
12+
### Added
13+
14+
- Double-click and one-command launcher files so non-technical users can install CodexKit from a release package more easily.
15+
- Interactive workspace creation wrappers for Windows and shell environments.
16+
17+
### Changed
18+
19+
- README and installation docs now include a detailed release-download path for non-coders.
20+
- Install scripts now report counts and clearer next steps after completion.
21+
- CI now validates installed skill counts dynamically and smoke-tests workspace scaffolding.
22+
- Release packaging now ships a full starter pack with skills, templates, workspaces, playbooks, automations, MCP guides, scripts, and quick-start launchers.
23+
1024
## [0.3.0] - 2026-03-20
1125

1226
### Added
@@ -45,7 +59,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
4559
- Cross-platform skill installation scripts and a validation script.
4660
- New docs site positioned for OpenAI Codex and ChatGPT users.
4761

48-
[Unreleased]: https://example.com/codexkit/compare/v0.3.0...HEAD
62+
[Unreleased]: https://example.com/codexkit/compare/v0.3.1...HEAD
63+
[0.3.1]: https://example.com/codexkit/releases/tag/v0.3.1
4964
[0.3.0]: https://example.com/codexkit/releases/tag/v0.3.0
5065
[0.2.0]: https://example.com/codexkit/releases/tag/v0.2.0
5166
[0.1.0]: https://example.com/codexkit/releases/tag/v0.1.0

CREATE-WORKSPACE-WINDOWS.cmd

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
@echo off
2+
setlocal
3+
cd /d "%~dp0"
4+
title CodexKit Starter Workspace
5+
6+
echo ==========================================
7+
echo CodexKit starter workspace scaffold
8+
echo ==========================================
9+
echo.
10+
echo Available starters:
11+
powershell -NoProfile -ExecutionPolicy Bypass -File "%~dp0scripts\quick-start.ps1" -List
12+
echo.
13+
set /p STARTER=Enter starter name:
14+
set /p DESTINATION=Enter destination folder (example: .\my-pmo):
15+
16+
if "%STARTER%"=="" (
17+
echo Starter name is required.
18+
pause
19+
exit /b 1
20+
)
21+
22+
if "%DESTINATION%"=="" (
23+
echo Destination is required.
24+
pause
25+
exit /b 1
26+
)
27+
28+
powershell -NoProfile -ExecutionPolicy Bypass -File "%~dp0scripts\quick-start.ps1" -Starter "%STARTER%" -Destination "%DESTINATION%"
29+
if errorlevel 1 (
30+
echo.
31+
echo Workspace creation failed.
32+
pause
33+
exit /b 1
34+
)
35+
36+
echo.
37+
echo Workspace created at %DESTINATION%.
38+
pause

CREATE-WORKSPACE.sh

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#!/usr/bin/env bash
2+
set -euo pipefail
3+
4+
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
5+
6+
echo "Available starters:"
7+
bash "$ROOT_DIR/scripts/quick-start.sh" --list
8+
echo
9+
read -r -p "Enter starter name: " STARTER
10+
read -r -p "Enter destination folder (example: ./my-pmo): " DESTINATION
11+
12+
if [[ -z "${STARTER}" || -z "${DESTINATION}" ]]; then
13+
echo "Starter name and destination are required." >&2
14+
exit 1
15+
fi
16+
17+
bash "$ROOT_DIR/scripts/quick-start.sh" --starter "$STARTER" --destination "$DESTINATION"
18+
echo "Workspace created at $DESTINATION"

README.md

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,24 @@ CodexKit is a fresh project rebuilt around the surfaces that matter in Codex tod
2424

2525
## Quick start
2626

27+
### Fastest path for non-coders
28+
29+
If you do not want to use Git commands or remember terminal steps, use the GitHub release package:
30+
31+
1. Open the Releases page for this repository.
32+
2. Download `codexkit-starter-pack-v0.3.1.zip`.
33+
3. Unzip it anywhere on your computer.
34+
4. On Windows, double-click `START-HERE-WINDOWS.cmd`.
35+
5. Restart Codex.
36+
6. In Codex, type `/skills` to confirm the pack appears.
37+
7. Optional: double-click `CREATE-WORKSPACE-WINDOWS.cmd` to create a starter workspace.
38+
39+
For macOS or Linux, download the same release package, unzip it, then run:
40+
41+
```bash
42+
bash ./START-HERE.sh
43+
```
44+
2745
### 1. Install CodexKit skills
2846

2947
Windows PowerShell:
@@ -40,6 +58,16 @@ bash ./scripts/install-skills.sh
4058

4159
By default, both scripts copy every folder from `skills/` into `$HOME/.agents/skills`, which matches the user-scope Codex Skills location documented by OpenAI.
4260

61+
Windows double-click install is also available:
62+
63+
- `START-HERE-WINDOWS.cmd`: installs the skills into `%USERPROFILE%\.agents\skills`
64+
- `CREATE-WORKSPACE-WINDOWS.cmd`: asks for a workspace starter and destination folder
65+
66+
Shell shortcuts are also available for extracted release packages:
67+
68+
- `START-HERE.sh`
69+
- `CREATE-WORKSPACE.sh`
70+
4371
For repository-scoped discovery, install the pack into `.agents/skills` inside the repo:
4472

4573
Windows PowerShell:
@@ -58,6 +86,12 @@ Codex scans `.agents/skills` from the current working directory up to the reposi
5886

5987
Codex can use skills through explicit invocation or implicit description matching. In CLI and IDE workflows, use `/skills` or type `$` to mention a skill directly. CodexKit keeps `codexkit-cloud-delegation` and `codexkit-automation-designer` explicit-only to avoid accidental activation on sensitive workflows.
6088

89+
If the install completed but the skills do not appear:
90+
91+
1. Restart Codex.
92+
2. Check that the skills were copied into `%USERPROFILE%\.agents\skills` on Windows or `$HOME/.agents/skills` on macOS/Linux.
93+
3. In Codex, use `/skills` to verify discovery.
94+
6195
### 2. Validate the pack
6296

6397
```bash
@@ -89,6 +123,12 @@ bash ./scripts/quick-start.sh --list
89123
bash ./scripts/quick-start.sh --starter finance-performance-desk --destination ./acme-finance
90124
```
91125

126+
For Windows users who prefer prompts instead of command arguments:
127+
128+
1. Double-click `CREATE-WORKSPACE-WINDOWS.cmd`.
129+
2. Copy the starter name from the list.
130+
3. Enter a destination folder such as `.\my-pmo` or `C:\Work\FinanceDesk`.
131+
92132
## Recommended adoption path
93133

94134
1. Install the skills into `$HOME/.agents/skills` or copy selected skills into repo-local `.agents/skills`.
@@ -134,13 +174,27 @@ CodexKit/
134174
- release workflow with packaged skill-pack artifacts
135175
- Dependabot updates for GitHub Actions and the docs app
136176
- separate docs app ready to publish
177+
- release packages that can be downloaded and installed by non-technical users
137178

138179
## Publish checklist
139180

140181
- Update repository URLs in docs and package metadata.
141182
- Replace placeholder maintainer details where needed.
142183
- Add screenshots or a short demo GIF to the docs site.
143-
- Tag `v0.3.0` after validating the pack and docs build.
184+
- Commit and push the release candidate branch or `main`.
185+
- Tag `v0.3.1` after validating the pack and docs build.
186+
- Push the tag to trigger the GitHub release workflow.
187+
188+
## Release process
189+
190+
1. Update `package.json`, `web/package.json`, and `CHANGELOG.md`.
191+
2. Run `npm run check`.
192+
3. Commit and push the release commit.
193+
4. Create the tag: `git tag v0.3.1`
194+
5. Push the tag: `git push origin v0.3.1`
195+
6. GitHub Actions publishes:
196+
`codexkit-source-v0.3.1.zip`
197+
`codexkit-starter-pack-v0.3.1.zip`
144198

145199
## Related files
146200

START-HERE-WINDOWS.cmd

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
@echo off
2+
setlocal
3+
cd /d "%~dp0"
4+
title CodexKit Quick Install
5+
6+
echo ==========================================
7+
echo CodexKit quick install for Windows
8+
echo ==========================================
9+
echo.
10+
echo This will install CodexKit skills into:
11+
echo %USERPROFILE%\.agents\skills
12+
echo.
13+
14+
powershell -NoProfile -ExecutionPolicy Bypass -File "%~dp0scripts\install-skills.ps1"
15+
if errorlevel 1 (
16+
echo.
17+
echo Installation failed.
18+
pause
19+
exit /b 1
20+
)
21+
22+
echo.
23+
echo CodexKit install complete.
24+
echo 1. Restart Codex if the skills do not appear immediately.
25+
echo 2. Type /skills in Codex to confirm installation.
26+
echo 3. Optional: double-click CREATE-WORKSPACE-WINDOWS.cmd to scaffold a starter workspace.
27+
echo.
28+
pause

START-HERE.sh

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
#!/usr/bin/env bash
2+
set -euo pipefail
3+
4+
ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
5+
6+
echo "=========================================="
7+
echo "CodexKit quick install"
8+
echo "=========================================="
9+
echo
10+
11+
bash "$ROOT_DIR/scripts/install-skills.sh"
12+
13+
echo
14+
echo "CodexKit install complete."
15+
echo "1. Restart Codex if the skills do not appear immediately."
16+
echo "2. Type /skills in Codex to confirm installation."
17+
echo "3. Optional: run bash ./CREATE-WORKSPACE.sh to scaffold a starter workspace."

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "codexkit",
3-
"version": "0.3.0",
3+
"version": "0.3.1",
44
"private": true,
55
"description": "Open-source operating kit for people using OpenAI Codex and ChatGPT across engineering, high-reasoning work, and repeatable office operations.",
66
"engines": {

scripts/install-skills.ps1

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ param(
66

77
$resolvedSource = (Resolve-Path $SourceDir).Path
88
New-Item -ItemType Directory -Force -Path $Destination | Out-Null
9+
$installedCount = 0
910

1011
Write-Host "Installing CodexKit skills from $resolvedSource"
1112
Write-Host "Destination: $Destination"
@@ -23,7 +24,12 @@ Get-ChildItem -Path $resolvedSource -Directory | ForEach-Object {
2324
}
2425

2526
Copy-Item -Recurse -Force $_.FullName $target
27+
$installedCount += 1
2628
Write-Host "Installed $($_.Name)"
2729
}
2830

29-
Write-Host "CodexKit skill installation complete."
31+
Write-Host "CodexKit skill installation complete. Installed $installedCount skills."
32+
Write-Host "Next steps:"
33+
Write-Host "1. Restart Codex if the skills do not appear immediately."
34+
Write-Host "2. Type /skills in Codex to confirm installation."
35+
Write-Host "3. Optional: run .\\scripts\\quick-start.ps1 -List to scaffold a starter workspace."

0 commit comments

Comments
 (0)