Skip to content

docs(release): reflect verified public package availability #74

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.

Sign up for GitHub

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
xiaoland merged 1 commit into from
Oct 26, 2026
Merged

docs(release): reflect verified public package availability #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,13 +153,14 @@ published and anonymously verified, a pnpm workspace can route the exact version

```yaml
overrides:
'@inkcre/ui-web@2.3.0': https://github.com/InKCre/ui/releases/download/%40inkcre%2Fui-web%402.3.0/inkcre-ui-web-2.3.0.tgz
"@inkcre/ui-web@2.6.0": https://github.com/InKCre/ui/releases/download/%40inkcre%2Fui-web%402.6.0/inkcre-ui-web-2.6.0.tgz
```

Regenerate and review the lockfile, then verify a fresh `pnpm install --frozen-lockfile` with an empty
store and no GitHub token, plus consumer builds. Never activate an override before its attachment
exists. The initial 2.3.0 attachment and `impl-ts` consumer cutover are pending release approval;
the current consumer lockfile still requires GitHub Packages access.
exists. Original 2.3.0, 2.5.0, and 2.6.0 tarballs are public. The `impl-ts` consumer cutover is
[merged and verified](https://github.com/InKCre/impl-ts/pull/171), including cold installs, consumer
builds, and real fork CI. Future UI upgrades must adopt their own verified exact-version override.

## GitHub Packages authentication

Expand Down
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,13 @@ Web 消费者从 `@inkcre/ui-web/logo/*` 导入，Swift 消费者依赖本仓库

### Use the package

The current GitHub Packages path requires package read access and npm authentication. A public
Release-tarball path is being prepared; see the [delivery and cutover contract](CONTRIBUTING.md#public-package-delivery)
before selecting an installation path.
Original packages are available through public Release assets without a token. Configure the
exact-version override in the [public delivery guide](CONTRIBUTING.md#public-package-delivery)
before adding the package, and keep the dependency version as semver for Module Federation.
The GitHub Packages registry path still requires package access and npm authentication.

```bash
pnpm add @inkcre/ui-web
pnpm add --save-exact @inkcre/ui-web@2.6.0
```

See [`packages/web/README.md`](packages/web/README.md) for installation, public entries, and the Skills shipped with the package. Browse the live component catalog at [design.inkcre.dev](https://design.inkcre.dev).
Expand Down
Loading