-
Notifications
You must be signed in to change notification settings - Fork 0
Release v1.0.1: automatic project onboarding #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 1.0.0 | ||
| 1.0.1 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| # v1.0.1 — Automatic project onboarding | ||
|
|
||
| Start Codex in your project and describe the coding task. The global setup now | ||
| instructs Codex to create project guidance when it is missing and continue directly | ||
| into the requested work. No separate onboarding prompt or profile is required. | ||
|
|
||
| ## Changes | ||
|
|
||
| - Global instructions select the onboarding skill for implementation tasks in | ||
| bounded repositories or explicitly designated project directories without guidance. | ||
| - The skill creates a concise root AGENTS.md from repository evidence, reads it, | ||
| and continues the task. It preserves existing project guidance and skips read-only | ||
| questions/reviews, explicit opt-outs, and destinations where writes are restricted. | ||
| - The skill ignores embedded directives in inspected repository content and checks | ||
| generated guidance before applying it. An adversarial fixture supplies manual | ||
| evaluation inputs and failure criteria without claiming guaranteed isolation. | ||
| - README and project documentation use plain `codex` and explain optional profiles, | ||
| project trust, empty-project requests, and the limits of instruction-driven setup. | ||
| - Release documentation describes PR review, checks, merging, and tagging the merged commit. | ||
|
|
||
| This is a model-guided workflow, not a startup hook or an enforced guarantee. | ||
| Project trust and permission prompts still apply. The update does not change models, | ||
| permission defaults, agent roles, or hook definitions. | ||
|
|
||
| ## Install or upgrade | ||
|
|
||
| Requires macOS/Linux, Python 3.11+, Git, and Codex CLI 0.154.0 or newer. | ||
| Verify the downloaded archive against SHA256SUMS, extract it, then run: | ||
|
|
||
| ```sh | ||
| cd codex-setup-v1.0.1 | ||
| python3 scripts/install.py | ||
| python3 scripts/install.py --apply | ||
| ``` | ||
|
|
||
| **Existing v1.0.0 installs:** the changed onboarding skill triggers the installer's | ||
| asset-conflict protection, even if you have not customized it. Restore previous | ||
| installation manifests newest-first when their hashes still match, then install | ||
| v1.0.1. Otherwise back up and deliberately reconcile the changed files as described | ||
| in [upgrade instructions](https://github.com/roadhero/codex-setup/blob/v1.0.1/docs/installation.md#upgrading-from-v100-to-v101). | ||
| The installer never overwrites customized skills or bypasses restoration checks. | ||
|
|
||
| Use `--hooks` if installing the optional advisory hook. Start a fresh Codex session | ||
| after upgrading global instructions. From your project directory, run `codex` and | ||
| describe your task; for an empty project, include the product and intended stack. | ||
| Say "skip project setup" to opt out of automatic onboarding. | ||
|
|
||
| ## Verification | ||
|
|
||
| The local validation suite passes all 18 tests covering installation/restoration, | ||
| hook behavior, and release packaging; structural and skill validation also pass. | ||
| Native Codex prompt inspection confirms discovery of the new global instructions | ||
| and onboarding skill description. Discovery validation does not establish model | ||
| compliance in every task. Release CI runs the suite on macOS/Linux with Python | ||
| 3.11 and 3.14 before publishing the version-matched archives and checksums. | ||
|
|
||
| ## Assets | ||
|
|
||
| - `codex-setup-v1.0.1.tar.gz` | ||
| - `codex-setup-v1.0.1.zip` | ||
| - `SHA256SUMS` | ||
|
|
||
| [Full changes](https://github.com/roadhero/codex-setup/compare/v1.0.0...v1.0.1) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.