openzim / openzim/javascript-libzim
Publish compiled ASM/WASM packages on NPM
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 5
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
This is a different issue from #8, though has some similarities.
@kelson has suggested that we should publish the compiled javascript-libzim binaries so they can be added to Kiwix JS and Kiwix PWA during CI and also during developer setup through npm install. This would make a lot of sense and would prevent keeping back copies of the binaries in Git history in those repositories.
The steps needed to achieve this here are:
- Set up the npm package repository (I don't know the right terminology)
- Probably (I am guessing) add a signing stage to the script that builds the binaries -- I assume NPM would require some verification/security system
- Modify the workflow so that it will publish the npm package(s) (which should only be done on publishing a release, and also with a workflow dispatch option).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with .github/workflows/build_libzim_wasm.yml and review how the compiled JavaScript-libzim binaries are built. Define the npm package setup and any signing or verification requirements, then update the workflow so publication occurs on releases and via workflow dispatch. Done means the compiled ASM/WASM packages can be installed by Kiwix JS and Kiwix PWA through npm.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, javascript, wasm
- Domain
- build-system, ci-cd, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100