Skip to content

Commit 70fc7fe

Browse files
tensornullCometAPI
andauthored
docs: advance to Public Preview (#8)
Co-authored-by: CometAPI <support@cometapi.com>
1 parent ca6c30c commit 70fc7fe

2 files changed

Lines changed: 52 additions & 41 deletions

File tree

AGENTS.md

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,22 @@ Python SDK repository. Treat this directory as the repository root.
66
## Repository authority
77

88
Repository-local source, tests, documentation, metadata, fixtures, and workflow
9-
definitions may be changed and verified locally. The current milestone may also
10-
create the empty private canonical repository, initialize and push its sanitized
11-
history, and observe credential-free GitHub Actions only when a maintainer has
12-
explicitly authorized those remote actions. Changing repository visibility,
13-
configuring secrets or environments, making live API requests, creating tags or
14-
releases, publishing to PyPI, and changing registry settings remain outside the
15-
current milestone.
9+
definitions may be changed and verified locally. The current milestone may use
10+
private pull requests and credential-free GitHub Actions to complete the
11+
remaining pre-visibility work. Changing repository visibility, configuring
12+
secrets or environments, making live API requests, creating tags or releases,
13+
publishing to PyPI, and changing registry settings remain outside the current
14+
authorized pre-visibility scope.
1615

1716
A local build, mocked test, statically valid workflow, or private remote CI run
1817
proves only its own evidence layer. Never invent or mock missing evidence.
1918

20-
## Current milestone: Private Remote Validation
19+
## Current milestone: Public Preview
2120

22-
Complete Private Remote Validation and stop before changing repository
23-
visibility. A session starting in this repository must be able to finish this
24-
milestone without instructions outside the repository.
21+
Private Remote Validation is complete. Prepare the private canonical repository
22+
for a future explicitly authorized visibility change, and stop before changing
23+
visibility. A session starting in this repository must be able to finish the
24+
remaining pre-visibility work without instructions outside the repository.
2525

2626
The accepted identity is:
2727

@@ -37,30 +37,22 @@ The accepted identity is:
3737
| Support and conduct | `support@cometapi.com` |
3838
| Security | `https://github.com/cometapi-dev/cometapi-python/security/advisories/new` |
3939

40-
Before the first remote push:
41-
42-
1. Apply the accepted identity to package metadata and public documents.
43-
2. Remove `.github/CODEOWNERS` and every check, fixture, test, or document that
44-
requires it. Do not replace it with an individual owner.
45-
3. Refactor the Public Preview document gate to collect and report all
46-
violations in one run while returning non-zero if any violation exists.
47-
Keep checks for canonical identity, contacts, repository metadata, public-
48-
safe language, and standalone content.
49-
4. Gate scheduled and manually dispatched live smoke with a
50-
`LIVE_SMOKE_ENABLED` repository variable. An unset or non-true value must
51-
prevent live execution. Keep
52-
`RELEASE_PLEASE_ENABLED` disabled through the initial manual alpha.
53-
5. Make the release live-model setting use `gpt-5.4` when
54-
`COMETAPI_LIVE_MODEL` is unset or empty; never allow an empty model value.
55-
6. Run every local offline, package, self-containment, public-content, secret,
56-
and workflow-static-validation gate.
57-
58-
When authorized, create an empty private repository without generated files,
59-
make the sanitized repository content its first commit, push the default
60-
branch, and wait for credential-free CI. Do not configure branch or tag rules,
61-
Private Vulnerability Reporting, secrets, protected environments, Trusted
62-
Publishing, or live smoke during the private stage. Record the real CI result
63-
and stop before any visibility change, even when all checks pass.
40+
Before changing repository visibility:
41+
42+
1. Resolve or explicitly defer every open dependency pull request that is not
43+
ready to merge. Dependabot PR #2 must not merge while its credential-free CI
44+
is failing; record its disposition in `ROADMAP.md`.
45+
2. Keep `.github/CODEOWNERS` absent until a real multi-maintainer model exists.
46+
3. Keep scheduled and manually dispatched live smoke fail-closed behind
47+
`LIVE_SMOKE_ENABLED=true`, and keep `RELEASE_PLEASE_ENABLED` disabled through
48+
the initial manual alpha.
49+
4. Run every local offline, package, self-containment, public-content, secret,
50+
and workflow-static-validation gate, then deliver the pre-visibility changes
51+
through a private pull request with successful credential-free CI.
52+
5. Confirm the canonical repository is still private and stop. Visibility,
53+
branch or tag rules, Private Vulnerability Reporting, secrets, protected
54+
environments, Trusted Publishing, live API calls, tags, releases, and
55+
publication require separate authorization after this stop point.
6456

6557
## Repository independence
6658

ROADMAP.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# CometAPI Python SDK Roadmap
22

33
Status: `0.1.0a1` in progress
4-
Last updated: 2026-07-21
4+
Last updated: 2026-07-22
55
Repository contract: this roadmap is self-contained.
66

77
## Product target
@@ -11,18 +11,18 @@ to CometAPI while preserving official request, response, error, retry, timeout,
1111
sync, async, and streaming behavior.
1212

1313
Private Remote Validation is complete for the sanitized repository, which
14-
remains private. Work stops before any visibility change. Public Preview and
15-
the functional `0.1.0a1` prerelease remain separate evidence gates. Support
16-
and release claims remain limited to the evidence defined in this roadmap and
17-
`COMPATIBILITY.md`.
14+
remains private. The current pre-visibility phase stops before any visibility
15+
change. Public Preview and the functional `0.1.0a1` prerelease remain separate
16+
evidence gates. Support and release claims remain limited to the evidence
17+
defined in this roadmap and `COMPATIBILITY.md`.
1818

1919
## Milestones
2020

2121
| Milestone | Status | Exit outcome |
2222
| --- | --- | --- |
2323
| Repository foundation | Complete | Public files, offline gates, packaging checks, and self-containment are complete. |
2424
| Private Remote Validation | Complete | The sanitized private repository passes real credential-free default-branch CI; public-only controls and live tests remain disabled. |
25-
| Public Preview | Planned | The public repository has blocking CI, repository rules, security reporting, protected environments, and authorized live-smoke evidence before it claims preview readiness. |
25+
| Public Preview | In progress | Pre-visibility work is delivered through private pull requests; after an authorized visibility change, the public repository must establish blocking CI, repository rules, security reporting, protected environments, and authorized live-smoke evidence before it claims preview readiness. |
2626
| `0.1.0a1` Registry Alpha | Planned | Early adopters can install a functional prerelease from PyPI. |
2727
| `0.1.0` stable | Planned | Complete runtime, release-PR, example, provenance, and registry gates pass. |
2828
| `0.2.0` provider-native text | Planned | Optional official Anthropic and Gemini adapters. |
@@ -97,6 +97,25 @@ Recorded evidence on 2026-07-21:
9797

9898
## Public Preview
9999

100+
Public Preview is in progress at the pre-visibility stage. Before requesting a
101+
visibility change:
102+
103+
- Deliver all remaining documentation and workflow changes through private pull
104+
requests with credential-free CI.
105+
- Review every open dependency pull request. Fix and merge only updates with
106+
complete successful CI; otherwise record an explicit deferral and keep the PR
107+
out of `main`.
108+
- Rerun the complete local gate and private pull-request CI, confirm the
109+
canonical repository remains private, and stop for explicit visibility-change
110+
authorization. Do not configure public-only controls, secrets, environments,
111+
live smoke, releases, or publication before that stop point.
112+
113+
Pre-visibility dependency disposition:
114+
115+
| Item | Disposition | Evidence and required action |
116+
| --- | --- | --- |
117+
| Dependabot [PR #2](https://github.com/cometapi-dev/cometapi-python/pull/2): `actions/checkout` 4.2.2 to 7.0.1 | Deferred; must not merge as-is | Credential-free [CI run 29796719306](https://github.com/cometapi-dev/cometapi-python/actions/runs/29796719306) failed in every test lane because the mutable-action-reference regression test hard-codes the previous v4 checkout SHA and no longer exercises its replacement; dependent artifact and copied-checkout jobs were skipped. Revisit only with version-independent regression coverage and a completely successful replacement CI run. The failed run is not upgrade evidence. |
118+
100119
Changing the repository to public begins a short configuration interval; it
101120
does not establish Public Preview readiness by itself. The preview is ready
102121
only when:

0 commit comments

Comments
 (0)