Skip to content

Include README and LICENSE in published package; fix stale branch refs#130

Merged
microbit-matt-hillsdon merged 3 commits intoappsfrom
links-fix
Apr 28, 2026
Merged

Include README and LICENSE in published package; fix stale branch refs#130
microbit-matt-hillsdon merged 3 commits intoappsfrom
links-fix

Conversation

@microbit-matt-hillsdon
Copy link
Copy Markdown
Contributor

  • Add prepack/postpack to copy README.md and LICENSE from the repo root into packages/microbit-connection so they ship in the npm tarball.
  • Fix reference to LICENCE.md from the package.json file.
  • Update README migration-guide URL from the apps branch to main. This doesn't work until we merge back but getting it in place now.
  • Tweek time-bound CreateAI sentence in the V1-no-DFU-service note.
  • Update MIGRATION.md.

- Add prepack/postpack to copy README.md and LICENSE from the repo root
  into packages/microbit-connection so they ship in the npm tarball.
- Fix reference to LICENCE.md from the package.json file.
- Update README migration-guide URL from the apps branch to main. This doesn't
  work until we merge back but getting it in place now.
- Tweek time-bound CreateAI sentence in the V1-no-DFU-service note.
- Update MIGRATION.md.
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Apr 28, 2026

Deploying microbit-connection with  Cloudflare Pages  Cloudflare Pages

Latest commit: f5479b6
Status:🚫  Build failed.

View logs

- Hardcode links for typedoc (main)
- Fix cross-module typedoc links and AbortSignal isn't ours
Copy link
Copy Markdown
Contributor

@microbit-grace microbit-grace left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a question and a suggestion, otherwise LGTM

Comment on lines +73 to +74
"prepack": "cp ../../README.md ../../LICENSE.md .",
"postpack": "rm -f README.md LICENSE.md"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Where are these used?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

By npm pack. The monorepo restructure means we need to grab the root ones for the package build as it doesn't have its own readme.

Comment thread README.md Outdated
@microbit-grace microbit-grace mentioned this pull request Apr 28, 2026
Co-authored-by: Grace <145345672+microbit-grace@users.noreply.github.com>
@microbit-matt-hillsdon microbit-matt-hillsdon merged commit 2ec8d27 into apps Apr 28, 2026
3 of 4 checks passed
@microbit-matt-hillsdon microbit-matt-hillsdon deleted the links-fix branch April 28, 2026 16:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants