-
Notifications
You must be signed in to change notification settings - Fork 106
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
Document what runtime environments Helia is tested and supported on #113
Comments
Historically supported versions have been covered by the IPFS contributing doc though to be fair, it's looking a bit out of date - still talks about webpack and ES2015 doesn't mention browsers or mobile. It could use updating and linking to from here. To be able to say we support mobile/tablet we need to be able to run the test suite on those platforms in CI. The various test runners for each environment are found here in aegir so a The structure of all the tests in our stack is that they are written using the mocha testing framework which we execute directly in Node.js, on Electron using electron-mocha, and headlessly in browsers via playwright-test which uses playwright under the hood. There's an issue open against playwright for supporting mobile browsers that's a few years old now so not sure it they're still working towards that, but it looks like browserstack have made progress in testing on devices using playwright so using an external service might be an option, though debugging becomes a lot harder since you aren't running tests locally at that point. Some further investigation is needed. |
Co-authored-by: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
## [@helia/ipns-v3.0.1](https://github.com/ipfs/helia-ipns/compare/@helia/ipns-v3.0.0...@helia/ipns-v3.0.1) (2023-12-08) ### Trivial Changes * fix docs and aegir dep in subpackages ([#142](ipfs/helia-ipns#142)) ([f66dd71](ipfs/helia-ipns@f66dd71)) * update sibling dependencies ([6ab5ddc](ipfs/helia-ipns@6ab5ddc)) * update sibling dependencies ([d0d84f0](ipfs/helia-ipns@d0d84f0)) ### Documentation * fix typo ([#113](ipfs/helia-ipns#113)) ([d732db9](ipfs/helia-ipns@d732db9))
Updates contributing doc to remove references to obsolete tools, add references to Unified CI and clarify supported platforms Refs: ipfs/helia#113 --------- Co-authored-by: Steve Loeppky <biglep@protocol.ai> Co-authored-by: Russell Dempsey <1173416+SgtPooki@users.noreply.github.com>
I added https://github.com/ipfs/helia/wiki/Development-and-Release-Process#what-runtimes-are-supported-by-helia and will close this for now. |
Done Criteria
It is self-service for a user to understand what runtimes the maintainers test Helia with and commit to spending time maintaining (e.g., troubleshooting issues).
Why Important
Sets clear expectations for users as they decide whether to adopt the project.
Make clear for maintainers with what level support they need to maintain as they make changes.
Notes
The text was updated successfully, but these errors were encountered: