tikitaki 0.1.4 → 0.1.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/PUBLISHING.md +8 -6
- package/README.md +5 -4
- package/package.json +1 -1
package/PUBLISHING.md
CHANGED
|
@@ -59,14 +59,16 @@ The repository includes `.github/workflows/npm-publish.yml`. Its job uses a GitH
|
|
|
59
59
|
|
|
60
60
|
A new npm trusted-publisher configuration must complete a successful publish within two days or it expires. Enable direct `npm publish` explicitly: current npm settings may otherwise allow only staged publication. See the [official trusted publishing guide](https://docs.npmjs.com/trusted-publishers/).
|
|
61
61
|
|
|
62
|
-
##
|
|
62
|
+
## Automatic publication through GitHub Actions
|
|
63
63
|
|
|
64
|
-
1. Merge the reviewed change into `main
|
|
65
|
-
2.
|
|
66
|
-
3.
|
|
67
|
-
4.
|
|
64
|
+
1. Merge the reviewed change into `main`. The complete tests/build/Pages/Release workflow must succeed.
|
|
65
|
+
2. Its successful `workflow_run` event automatically starts **Publish npm packages**. Failed, cancelled, pull-request, and fork runs cannot publish.
|
|
66
|
+
3. The publication job selects the version from the exact completed run's release artifact. It does not guess from the latest release, so a newer concurrent release cannot change the publication target.
|
|
67
|
+
4. The job downloads those release archives, verifies checksums and version, and publishes the core followed by all four adapters through OIDC.
|
|
68
68
|
5. Verify registry metadata and test installation in a clean application before announcing the release.
|
|
69
69
|
|
|
70
|
-
|
|
70
|
+
To retry manually, open **Actions → Publish npm packages → Run workflow** on `main` and enter the existing stable release tag. Previously published identical archives are skipped. The workflow filename and `npm` environment are unchanged, so the existing npm Trusted Publisher settings continue to apply.
|
|
71
|
+
|
|
72
|
+
Publication runs are serialized and are not cancelled midway by a newer publication request. Ordinary CI runs still cancel outdated tests and builds on the same branch. Every successful main release is published automatically; manual dispatch is a recovery path.
|
|
71
73
|
|
|
72
74
|
After the initial packages exist, verify that the README installation commands resolve the intended public packages. Keep package metadata, adapter guides, and the registry pages consistent.
|
package/README.md
CHANGED
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
# TikiTaki
|
|
2
2
|
|
|
3
3
|
[](https://github.com/gagarinbefree/TikiTaki/actions/workflows/ci-pages.yml)
|
|
4
|
-
[](https://github.com/gagarinbefree/TikiTaki/releases/latest)
|
|
5
|
+
[](https://www.npmjs.com/package/tikitaki)
|
|
5
6
|
|
|
6
7
|
[Live demo](https://gagarinbefree.github.io/TikiTaki/) · [Releases](https://github.com/gagarinbefree/TikiTaki/releases) · [Report an issue](https://github.com/gagarinbefree/TikiTaki/issues/new)
|
|
7
8
|
|
|
8
|
-
**Latest release:** <!-- release-version -->v0.1.
|
|
9
|
+
**Latest release:** <!-- release-version -->v0.1.5<!-- /release-version -->
|
|
9
10
|
|
|
10
11
|
TikiTaki is a TypeScript library for swipe navigation through a two-dimensional grid whose rows can have different lengths. Use it for paged interfaces, galleries, stories, or component-based feeds. You supply the content; TikiTaki handles navigation, pointer gestures, animation, and cell lifecycle.
|
|
11
12
|
|
|
@@ -31,7 +32,7 @@ npm install tikitaki @tikitaki_gagarinbefree/svelte
|
|
|
31
32
|
npm install tikitaki @tikitaki_gagarinbefree/angular
|
|
32
33
|
```
|
|
33
34
|
|
|
34
|
-
Your application supplies the adapter's framework peer dependencies. Install only the adapter for your framework.
|
|
35
|
+
Your application supplies the adapter's framework peer dependencies. Install only the adapter for your framework. The [core](https://www.npmjs.com/package/tikitaki) and adapters under [@tikitaki_gagarinbefree](https://www.npmjs.com/org/tikitaki_gagarinbefree) are available from npm. To install an archived build or inspect its contents, use the tested tarballs from [GitHub Releases](https://github.com/gagarinbefree/TikiTaki/releases) or build from source below. Release downloads include an integrity manifest; maintainer publication instructions are in [PUBLISHING.md](./PUBLISHING.md).
|
|
35
36
|
|
|
36
37
|
### Build from source
|
|
37
38
|
|
|
@@ -291,7 +292,7 @@ No application or maintainer invitation is needed to start contributing. Pick an
|
|
|
291
292
|
|
|
292
293
|
The [GitHub Actions workflow](./.github/workflows/ci-pages.yml) validates pull requests and pushes to `main`. It runs type checks, lint, formatting, unit/integration tests, package validation, production builds, and Chrome desktop/touch E2E. PR runs do not publish upstream releases or deploy upstream Pages. A new commit cancels the earlier pipeline for the same branch or PR.
|
|
293
294
|
|
|
294
|
-
After a successful `main` run, the tested demo artifact is deployed to [GitHub Pages](https://gagarinbefree.github.io/TikiTaki/) and a matching [GitHub Release](https://github.com/gagarinbefree/TikiTaki/releases) is created. Stable release versions advance by one patch, such as `v0.1.1` → `v0.1.2`. The release includes the demo archive, `version.json`, npm package tarballs, and their integrity manifest. A bot updates the README badge and package versions. npm publication
|
|
295
|
+
After a successful `main` run, the tested demo artifact is deployed to [GitHub Pages](https://gagarinbefree.github.io/TikiTaki/) and a matching [GitHub Release](https://github.com/gagarinbefree/TikiTaki/releases) is created. Stable release versions advance by one patch, such as `v0.1.1` → `v0.1.2`. The release includes the demo archive, `version.json`, npm package tarballs, and their integrity manifest. A bot updates the README badge and package versions. After the successful main workflow finishes, npm publication starts automatically through the trusted publisher. A manual run remains available for retries. Contributors do not need to edit those generated release fields in feature PRs.
|
|
295
296
|
|
|
296
297
|
If you want Pages for your own fork, enable Actions, select **Settings → Pages → Source → GitHub Actions**, and allow the `github-pages` environment to deploy from your fork's `main`. If you rename the repository, update `DEPLOYMENT_CONFIG.basePath` in [tooling.config.mjs](./tooling.config.mjs). Fork deployments and releases belong to the fork; upstream releases follow the upstream workflow.
|
|
297
298
|
|