yeelight-home 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/DISTRIBUTION.md +17 -5
- package/INSTALL.md +1 -1
- package/README.md +1 -1
- package/package.json +1 -1
package/DISTRIBUTION.md
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
| Channel | GoReleaser role | User install path |
|
|
8
8
|
| --- | --- | --- |
|
|
9
9
|
| GitHub Releases | Primary release target for archives, installers, checksums, SBOMs, packages, and metadata. | `curl -fsSL https://github.com/Yeelight/yeelight-home/releases/latest/download/install.sh \| sh` |
|
|
10
|
-
| Homebrew tap | Updates
|
|
10
|
+
| Homebrew tap | Updates Formula compatibility metadata and Cask metadata in `Yeelight/homebrew-tap`. | `brew install Yeelight/tap/yeelight-home` |
|
|
11
11
|
| Scoop bucket | Updates manifest metadata in `Yeelight/scoop-bucket`. | `scoop bucket add yeelight https://github.com/Yeelight/scoop-bucket && scoop install yeelight-home` |
|
|
12
12
|
| npm wrapper | Publishes the launcher package after GoReleaser assets exist. | `npm install -g yeelight-home` |
|
|
13
13
|
| Linux packages | Builds `.deb`, `.rpm`, `.apk`, and Arch package artifacts through nFPM. | Download package assets from GitHub Releases. |
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
| AUR | Publishes `yeelight-home-bin` only when AUR SSH is configured. | `yay -S yeelight-home-bin` after publication. |
|
|
16
16
|
| Snap | Builds/publishes only when Snapcraft credentials and store review are ready. | `sudo snap install yeelight-home` after store visibility. |
|
|
17
17
|
| Docker GHCR | Publishes multi-arch images when registry credentials are available. | `docker run --rm ghcr.io/yeelight/yeelight-home:latest version` |
|
|
18
|
-
| Docker Hub | Publishes multi-arch images when Docker Hub credentials are available. | `docker run --rm
|
|
18
|
+
| Docker Hub | Publishes multi-arch images when Docker Hub credentials are available. | `docker run --rm yeelightdev/yeelight-home:latest version` |
|
|
19
19
|
| pkg.go.dev | Indexes public `v*` module tags. | `https://pkg.go.dev/github.com/yeelight/yeelight-home` |
|
|
20
20
|
|
|
21
21
|
## Repository Layout Policy
|
|
@@ -41,7 +41,7 @@ Reasoning:
|
|
|
41
41
|
- It aligns with Go CLI user expectations and improves discoverability through package managers.
|
|
42
42
|
- It still does not remove external gates: Winget review, AUR account/SSH, Snapcraft credentials, Docker Hub credentials, and Homebrew/Scoop write tokens are still required.
|
|
43
43
|
- The public workflow automatically skips channels whose secrets are not configured, so optional channels do not block core GitHub Release assets, checksums, install scripts, npm wrapper assets and Linux package assets.
|
|
44
|
-
- GoReleaser v2.16 marks Homebrew formula generation as deprecated. New automation
|
|
44
|
+
- GoReleaser v2.16 marks Homebrew formula generation as deprecated. New automation still updates the Formula compatibility path because many users install with `brew install Yeelight/tap/yeelight-home`; it also publishes the Cask path for the recommended newer Homebrew metadata model.
|
|
45
45
|
|
|
46
46
|
Scope:
|
|
47
47
|
|
|
@@ -107,14 +107,14 @@ Target artifacts:
|
|
|
107
107
|
- `.apk`
|
|
108
108
|
- Arch package artifact
|
|
109
109
|
- Package-manager manifests:
|
|
110
|
-
- Homebrew
|
|
110
|
+
- Homebrew Formula and Cask in `Yeelight/homebrew-tap`
|
|
111
111
|
- Scoop manifest in `Yeelight/scoop-bucket`
|
|
112
112
|
- Winget manifest or PR flow once enabled
|
|
113
113
|
- AUR `yeelight-home-bin` once AUR SSH is configured
|
|
114
114
|
- Snap package once Snapcraft is configured
|
|
115
115
|
- Container images:
|
|
116
116
|
- `ghcr.io/yeelight/yeelight-home`
|
|
117
|
-
- `
|
|
117
|
+
- `yeelightdev/yeelight-home`
|
|
118
118
|
|
|
119
119
|
## Required Release Settings
|
|
120
120
|
|
|
@@ -130,6 +130,7 @@ GitHub Actions provides `GITHUB_TOKEN` automatically for GitHub Releases and GHC
|
|
|
130
130
|
| `AUR_KEY` | AUR SSH private key for `yeelight-home-bin`. |
|
|
131
131
|
| `SNAPCRAFT_STORE_CREDENTIALS` | Snap store publish credentials. |
|
|
132
132
|
| `WINGET_GITHUB_TOKEN` | Winget manifest PR token. |
|
|
133
|
+
| `YEELIGHT_HOME_RELEASE_TOKEN` | Push runtime mirror snapshots to `Yeelight/yeelight-home`. |
|
|
133
134
|
|
|
134
135
|
| Repository Variable | Purpose |
|
|
135
136
|
| --- | --- |
|
|
@@ -137,9 +138,20 @@ GitHub Actions provides `GITHUB_TOKEN` automatically for GitHub Releases and GHC
|
|
|
137
138
|
| `WINGET_REPOSITORY_NAME` | Winget PR workspace fork name. |
|
|
138
139
|
| `WINGET_REPOSITORY_BRANCH` | Optional Winget PR branch. Defaults to a release-specific branch. |
|
|
139
140
|
| `AUR_GIT_URL` | Optional AUR Git URL override. Defaults to `ssh://aur@aur.archlinux.org/yeelight-home-bin.git`. |
|
|
141
|
+
| `DOCKERHUB_IMAGE` | Optional Docker Hub image override. Defaults to `<DOCKERHUB_USERNAME>/yeelight-home`. |
|
|
140
142
|
|
|
141
143
|
Only configure settings for channels that are ready to publish.
|
|
142
144
|
Without Winget token and PR workspace variables, the public release workflow skips Winget and still publishes core GitHub Release artifacts.
|
|
145
|
+
You can self-solve Winget by forking `microsoft/winget-pkgs` as the PR workspace and pointing the repository variables at that fork; no permanent Yeelight organization repository is required for Winget publication.
|
|
146
|
+
Without `YEELIGHT_HOME_RELEASE_TOKEN`, the monorepo mirror workflow cannot push runtime-only source snapshots into the public repository.
|
|
147
|
+
AUR is optional until the package repository and SSH key are available.
|
|
148
|
+
Snapcraft is optional until a Linux or Ubuntu runner can execute the login/export flow and store publication.
|
|
149
|
+
|
|
150
|
+
Reusable GitHub credential pattern:
|
|
151
|
+
|
|
152
|
+
- One GitHub PAT can be reused for `YEELIGHT_HOME_RELEASE_TOKEN`, `HOMEBREW_TAP_GITHUB_TOKEN`, `SCOOP_BUCKET_GITHUB_TOKEN`, and `WINGET_GITHUB_TOKEN` if it has write access to the target repos or PR workspace.
|
|
153
|
+
- `YEELIGHT_HOME_RELEASE_TOKEN` only needs write access to `Yeelight/yeelight-home`.
|
|
154
|
+
- The package-manager tokens only need write access to their own target repositories or PR workspace.
|
|
143
155
|
|
|
144
156
|
## npm Package Model
|
|
145
157
|
|
package/INSTALL.md
CHANGED
|
@@ -182,7 +182,7 @@ docker run --rm ghcr.io/yeelight/yeelight-home:latest version
|
|
|
182
182
|
Docker Hub:
|
|
183
183
|
|
|
184
184
|
```sh
|
|
185
|
-
docker run --rm
|
|
185
|
+
docker run --rm yeelightdev/yeelight-home:latest version
|
|
186
186
|
```
|
|
187
187
|
|
|
188
188
|
Persist local config and credentials:
|
package/README.md
CHANGED
|
@@ -216,7 +216,7 @@ One tagged public `v*` release can produce:
|
|
|
216
216
|
|
|
217
217
|
- macOS, Linux, Windows archives for `amd64`, `arm64`, and Linux `armv7`.
|
|
218
218
|
- Checksums and release metadata.
|
|
219
|
-
- Homebrew tap
|
|
219
|
+
- Homebrew tap Formula compatibility and Cask automation.
|
|
220
220
|
- Scoop bucket manifest.
|
|
221
221
|
- Linux packages through nFPM: `.deb`, `.rpm`, `.apk`, and Arch package artifacts.
|
|
222
222
|
- Docker/GHCR and Docker Hub multi-arch images.
|
package/package.json
CHANGED