🤞 Sync 2026-09-27 22:16:29

luci-app-overview-manager/docs/DEVELOPMENT.md

@@ -0,0 +1,38 @@
+# Development
+
+## Checks
+
+```sh
+./scripts/ci-check.sh
+```
+
+## Building
+
+The IPK is written to `dist/`. The APK is built with the official OpenWrt 25.12
+SDK:
+
+```sh
+OPENWRT_SDK_DIR=/path/to/openwrt-sdk-25.12.x-target \
+  ./scripts/build-apk.sh
+```
+
+A release APK is signed with the shared publisher key:
+
+```sh
+OPENWRT_SDK_DIR=/path/to/openwrt-sdk-25.12.x-target \
+OPENWRT_APK_SIGNING_KEY=/secure/path/release-private.pem \
+  ./scripts/build-apk-release.sh
+```
+
+The private half of the publisher key is not stored in any repository. This
+repository builds and signs only its own package and publishes it as a release
+asset; the index is assembled by
+[Nikitid/openwrt-feed](https://github.com/Nikitid/openwrt-feed). See
+[Joining the shared feed](https://github.com/Nikitid/openwrt-feed/blob/main/docs/MEMBER_INTEGRATION.md).
+
+## Release
+
+Push a `vX.Y.Z` tag matching the version in `release.env`. The release workflow
+checks the tag, runs `scripts/ci-check.sh`, builds and signs the APK with the
+pinned OpenWrt SDK, and publishes the release with notes made by
+`scripts/release-notes.sh` from the commit subjects since the previous tag.