AAA
f92162b3bb
Piik now has one public presentation and a coordinated App/Server release path. This phase unifies the room UI, rewrites the bilingual README and guides, adds a static website with an inline product film, and prepares matching GitHub/Gitee packages and update links. The film uses the current homepage and shared product controls on one seekable timeline. Runtime fixes preserve presentation when the App opens a room, normalize Site origins, and keep capture and media-recovery status in the television indicator. New visits use Chinese for a Chinese system language and English otherwise; explicit language and visual-mode choices remain available. An optional site passphrase controls site entry, while room authorization remains enforced. GitHub is the release authority. Gitee mirrors verified packages and provides update metadata when GitHub is unavailable. Reviewed PR release notes become the GitHub Release description. The separate public demo uses P2P only, with HTTPS and STUN verified. Validation: 756 Web tests, TypeScript and production build; Go core tests, formatting, vet and available target builds; bounded Windows capture and App/Site interoperability; browser film checks, audible playback and narrow layouts; anonymous Gitee Windows-package download, checksum and launcher/update-link checks. Public demo acceptance covers authenticated WebSocket signaling, synthetic P2P video and room cleanup on one network. macOS/Linux physical capture and the wider device/network/endurance matrix remain explicitly deferred. Publication builds every package from the merged source SHA. The repository is public, main protection is active, and Pages is configured for piik.tv. CI/publisher and Pages deployment records own publication results. ## Release notes ### 中文 Piik 是免费开源的屏幕共享工具。开个房间，发出邀请，最多 20 位朋友就能用浏览器加入观看。 - 使用浏览器或 Piik App 分享游戏、窗口和整个屏幕。 - 优先建立直连；自托管站点可开启媒体转发作为备用线路。 - Piik App 支持本地房间、临时公网邀请和已有站点。 - Piik Server 内置网页界面、房间管理和连接服务，方便自行部署。 - 提供中英文界面与使用指南，以及 GitHub、Gitee 两条下载线路。 [官网](https://piik.tv) · [在线体验](https://demo.piik.tv) · [使用指南](https://github.com/TNTcraftHIM/Piik/blob/main/docs/guide/getting-started.zh-CN.md) · [自行部署](https://github.com/TNTcraftHIM/Piik/blob/main/docs/operations/self-hosting.zh-CN.md) · [Gitee 下载](https://gitee.com/TNTcraftHIM/Piik/releases) Windows App 和桌面浏览器是本次主要验证的平台。macOS 和 Linux 尚未经过实机测试，欢迎有设备的朋友测试并反馈。演示站和 App 公网邀请使用 P2P，受限网络下可能无法连接；自托管站点可开启媒体转发。 ### English Piik is free, open-source screen sharing for you and up to 20 viewers. Start a room, send an invitation, and your friends can join in a browser. - Share games, windows or a whole screen from your browser or Piik App. - Direct connections come first, with optional media forwarding on self-hosted sites. - Piik App supports local rooms, temporary public invitations and existing sites. - Piik Server includes the web interface, rooms and connection services for self-hosting. - English and Chinese interfaces and guides are available, with GitHub and Gitee downloads. [Website](https://piik.tv) · [Online demo](https://demo.piik.tv) · [User guide](https://github.com/TNTcraftHIM/Piik/blob/main/docs/guide/getting-started.md) · [Self-hosting](https://github.com/TNTcraftHIM/Piik/blob/main/docs/operations/self-hosting.md) · [Gitee downloads](https://gitee.com/TNTcraftHIM/Piik/releases) Windows App and desktop browsers are the primary validated paths. macOS and Linux have not yet been tested on physical devices; testing and feedback are welcome. The demo and App public invitations rely on P2P and may not connect on restrictive networks. Self-hosted sites can enable media forwarding.
95 lines
5.4 KiB
Markdown
95 lines
5.4 KiB
Markdown
# GitHub Repository And Releases
|
|
|
|
[Versioning](../reference/versioning.md) owns release meaning and compatibility;
|
|
[CONTRIBUTING](../../CONTRIBUTING.md) owns review and local validation. This file
|
|
owns the one-time GitHub settings. The source repository is public; automatic
|
|
package publication has its own activation gate below.
|
|
|
|
## Main And Pull Requests
|
|
|
|
Use squash merging only, with the PR title and body as the squash commit. These
|
|
repository settings are applied. Keep automatic branch deletion off: the normal
|
|
cleanup step checks local worktrees and remaining references first.
|
|
|
|
Protect `main` with PRs required, zero mandatory peer approvals for the solo
|
|
maintainer, administrator enforcement, linear history, and no force pushes or
|
|
deletions. Do not require cloud PR checks while branch/PR CI is intentionally
|
|
quiet; local validation and acceptance precede the squash merge. PR/issue
|
|
templates live in `.github/`; [naming](../../CONTRIBUTING.md#commit-pr-and-branch-names)
|
|
is shared with automatic version selection.
|
|
|
|
These protections are active, including conversation resolution. GitHub Pages
|
|
uses the **GitHub Actions** publishing source and the `piik.tv` custom domain;
|
|
the repository homepage points to `https://piik.tv`. The dedicated Website
|
|
workflow publishes the static site under [website operations](./website.md).
|
|
|
|
## Enable Automatic Publication Once
|
|
|
|
Before enabling, accept the release packages, compatibility baseline, public
|
|
copy and repository visibility; finish main protection. Then set repository
|
|
Actions variable `PIIK_RELEASES_ENABLED` to `true`. This is a repository setting,
|
|
not an environment variable for Piik App or Server.
|
|
|
|
Subsequent accepted PRs merged to main use the existing CI workflow: calculate
|
|
one version, validate, package Server and all App targets, and publish the same
|
|
artifacts. Runs queue rather than overlap or cancel one another. Branches/PRs
|
|
stay quiet; manual `client_checks` dispatch remains available for candidates.
|
|
Writing a new version back to main is unnecessary and prohibited.
|
|
|
|
For a complete publisher rehearsal, dispatch with `client_checks: true` and an
|
|
explicit `candidate_version` such as `v1.0.0`. This builds genuine Server and
|
|
native App artifacts under one revision and version without tagging or
|
|
publishing. Prepare its [release-note section](../reference/versioning.md#release-notes)
|
|
and inspect the generated preview in the run summary. For a local preview, run
|
|
`node scripts/release-notes.mjs v1.0.0 FULL_SOURCE_SHA` from the checkout with
|
|
full history and tags. Download that run's artifacts and pass their directory, version and
|
|
full revision to `scripts/publish-release.mjs --dry-run` (put the flag after
|
|
the three positional arguments). An omitted candidate version keeps the usual
|
|
development/exact-tag identity.
|
|
|
|
Enable GitHub's built-in release immutability for formal publication where
|
|
available. Upload all assets to the draft before publishing. A failed upload can
|
|
resume its same-source draft; a published version is never clobbered. If its
|
|
files are wrong or incomplete, publish a corrected new version. An older retry
|
|
must not replace a newer release's `latest` designation.
|
|
|
|
To stop future automatic publication, remove/set false the activation variable;
|
|
this does not alter existing releases or a currently running workflow. Inspect
|
|
the active run separately. No pipeline step changes visibility or installs an
|
|
update into a running Piik deployment.
|
|
|
|
## Gitee Download Mirror
|
|
|
|
[TNTcraftHIM/Piik](https://gitee.com/TNTcraftHIM/Piik) is a public README/Release
|
|
mirror. Source, documentation and issues stay on GitHub. The publishing job uses
|
|
the repository Actions secret `GITEE_TOKEN`, which is configured; rotate it there
|
|
when needed. Never put it in source, a remote URL or a distributed package.
|
|
GitHub publication continues to use the workflow's scoped token.
|
|
|
|
After GitHub publication, the same job runs `scripts/mirror-release.mjs` on the
|
|
original artifacts. Upload failure leaves the Gitee release marked as a preview.
|
|
Rerun the failed publishing job to verify existing files and upload only missing
|
|
ones. GitHub's published release remains unchanged. Both publishers reject
|
|
changing a published package; use a corrected new version if its bytes are wrong.
|
|
|
|
If the original Actions artifacts have expired, download that release's files
|
|
from GitHub into an external working directory, then run:
|
|
|
|
```sh
|
|
gh release download v1.0.0 --repo TNTcraftHIM/Piik --dir /tmp/piik-mirror
|
|
node scripts/mirror-release.mjs /tmp/piik-mirror v1.0.0 FULL_SOURCE_SHA
|
|
```
|
|
|
|
Use the release's actual version and full `target_commitish` SHA, with
|
|
`GITEE_TOKEN` supplied through the publisher environment. `--dry-run` after the
|
|
three arguments checks local identity, checksums and attachment sizes without
|
|
publishing. The [release-source policy](../reference/versioning.md#release-sources)
|
|
owns provenance, selection and quota limits. Small-file upload/download acceptance
|
|
has passed; full-package mirror acceptance remains part of release readiness.
|
|
|
|
## Platform References
|
|
|
|
- [Protected branch availability](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)
|
|
- [Workflow concurrency and queued runs](https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#example-queueing-multiple-pending-runs)
|
|
- [Immutable release workflow](https://docs.github.com/en/code-security/concepts/supply-chain-security/immutable-releases)
|