-
Notifications
You must be signed in to change notification settings - Fork 3
feat(PE-851): Add Example for Self-Updating Application in dev-cookbook #84
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.
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
Adds a complete example of a self-updating JavaScript application for BrightSign players, including build configs, runtime code, an optional server, and documentation.
- Introduces a TypeScript-based updater app with Webpack and TS configuration
- Adds an optional Express server to serve the
autorun.zippackage - Provides a BrightScript
autorun.brsscript and README instructions
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| examples/bs-app-updater-example/webpack.config.js | Webpack config for building the updater app |
| examples/bs-app-updater-example/tsconfig.json | TypeScript compiler settings |
| examples/bs-app-updater-example/server/package.json | Defines the optional server’s package metadata |
| examples/bs-app-updater-example/server/index.js | Express server to deliver autorun.zip |
| examples/bs-app-updater-example/package.json | Main updater app’s package metadata and dependencies |
| examples/bs-app-updater-example/index.ts | Core logic for downloading, unzipping, backup, and reboot |
| examples/bs-app-updater-example/autorun.brs | BrightScript autorun entrypoint for the updater |
| examples/bs-app-updater-example/README.md | Instructions for setup, build, and usage |
Comments suppressed due to low confidence (2)
examples/bs-app-updater-example/README.md:55
- The README instructs
npm run buildfor the server, butserver/package.jsonhas nobuildscript. Either add a build script or remove this step.
npm run build
examples/bs-app-updater-example/index.ts:30
- [nitpick] This critical download-and-unzip function lacks unit tests to verify success, error paths, and edge cases. Consider adding tests around network errors, invalid zips, and permission failures.
async function downloadAndUnzipFile(url: string, dest: string): Promise<boolean> {
evan-morgan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only 1 real point to address, the rest are just not-why comments
4d6bd20 to
67a4f64
Compare
evan-morgan
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job, LGTM
📝 Description
Issue: JIRA - PE-851
✔️ Dev Complete Checklist