Skip to content

Build tooling and packaging updates #46

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

Merged
merged 22 commits into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
232fe3d
Tests, CJS, ESM builds work.
microbit-matt-hillsdon Jan 27, 2025
ef8b453
Modern linting from eslint
microbit-matt-hillsdon Jan 27, 2025
c94d6b0
First pass simplifying the docs
microbit-matt-hillsdon Jan 27, 2025
b8550dd
Set outDir for build as dist in tsconfig
microbit-grace Jan 28, 2025
ecb52e0
Fix CI: Run tests in workflow
microbit-grace Jan 28, 2025
6b6dc4c
Add esModuleInterop to fix MemoryMap imports
microbit-matt-hillsdon Jan 28, 2025
eb087ce
Use extensions on imports for Node
microbit-matt-hillsdon Jan 28, 2025
fd5cb66
Add build-docs.yml
microbit-grace Jan 28, 2025
be122cc
Only run build-docs on master/tag creation
microbit-grace Jan 28, 2025
cf3d45d
Use the upstream types
microbit-matt-hillsdon Jan 28, 2025
b6564d0
Merge branch 'build-updates' of github.com:microbit-foundation/microb…
microbit-matt-hillsdon Jan 28, 2025
7820d62
Docs tidying/tweaks
microbit-matt-hillsdon Jan 28, 2025
bcd39ac
Audit fix
microbit-matt-hillsdon Jan 28, 2025
5ebb74a
Empty config dir
microbit-grace Jan 28, 2025
cd68033
Add link to micropythonFsHex class
microbit-grace Jan 28, 2025
2ec21d0
Updating docs
microbit-grace Jan 28, 2025
e555053
Modernise docs + link to API
microbit-matt-hillsdon Jan 28, 2025
609ea2f
Tweak quick guide docs
microbit-grace Jan 29, 2025
2527ea2
Run lint in ci
microbit-grace Jan 29, 2025
01a2731
Fix prettier
microbit-grace Jan 29, 2025
953c251
Revert unintended change
microbit-grace Jan 29, 2025
c6c0617
Document `npm install` instead of `npm add`
microbit-grace Jan 29, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/workflows/build-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: build-docs
on:
release:
types: [created]
push:
branches:
- master
tags:
- '**'
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Pages
uses: actions/configure-pages@v5
- run: npm ci
- name: Build docs
run: npm run docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/build

deploy:
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 1 addition & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ jobs:
registry-url: 'https://registry.npmjs.org'
cache: npm
- run: npm ci
- run: npm run test:coverage
- run: npm run build
- run: npm run ci
- run: npm publish
if: github.event_name == 'release' && github.event.action == 'created'
env:
Expand Down
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ lib-fesm
fesm
umd
bundles
dist
dist/

## this is generated by `npm pack`
*.tgz
package

docs/build/

# This is just for personal use
ignore/
2 changes: 2 additions & 0 deletions .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,5 @@ examples
## this is generated by `npm pack`
*.tgz
package

**/__tests__/**
4 changes: 1 addition & 3 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,5 @@
"typescript.implementationsCodeLens.enabled": true,
"typescript.referencesCodeLens.enabled": true,
"javascript.referencesCodeLens.enabled": true,
"editor.rulers": [
80,100
]
"editor.rulers": [80, 100]
}
6 changes: 2 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
Thanks for looking here! We'd love your help. The micro:bit project is only
possible through contributions of companies and individuals around the world.

This project is managed on GitHub, and the best way to contribute is to jump in
and fix/file issues.

https://github.com/microbit-foundation/microbit-fs
This project is managed [in this GitHub project](https://github.com/microbit-foundation/microbit-fs), and the best way to contribute
is to jump in and fix/file issues.

If you're interested in working on any of these items, please file an issue
and mention @microbit-carlos.
34 changes: 0 additions & 34 deletions config/global.d.ts

This file was deleted.

27 changes: 0 additions & 27 deletions config/jest.config.js

This file was deleted.

107 changes: 0 additions & 107 deletions config/rollup.config.js

This file was deleted.

2 changes: 0 additions & 2 deletions config/setup-tests.js

This file was deleted.

16 changes: 0 additions & 16 deletions config/tsconfig.json

This file was deleted.

60 changes: 0 additions & 60 deletions config/typedoc.json

This file was deleted.

14 changes: 0 additions & 14 deletions config/types.d.ts

This file was deleted.

18 changes: 0 additions & 18 deletions docs/api-docs.md

This file was deleted.

Loading