Skip to content

Commit

Permalink
Merge pull request #97 from ipfs/SgtPooki-version-support-definition
Browse files Browse the repository at this point in the history
docs(readme): document version & platform support
  • Loading branch information
lidel authored Aug 29, 2022
2 parents a1c0377 + 1a59dd7 commit 8a7310a
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,27 @@ This `ipfs-gui` repo is intended primarily as a higher-order planning and discus
[IPFS Web UI]: https://github.com/ipfs-shipyard/ipfs-webui "Web-based IPFS file manager and network explorer"
[IPFS Desktop]: https://github.com/ipfs-shipyard/ipfs-desktop "Launch and manage IPFS from a desktop app"
[IPFS Companion]: https://github.com/ipfs/ipfs-companion "Integrate IPFS with your browser"

## Support goals

### Platforms

Due to the difficulty involved in debugging and development on platforms and versions not supported by github actions (and our CI/CD tests), we can only provide support for the [top 3 (mac, windows, ubuntu) `latest` platforms supported by github](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners#supported-runners-and-hardware-resources).

If there is a new platform release, we will support bug-fixes and feature enhancements for that new platform, but will prioritize bug-fixes for things we can automate (CI/CD supported bugs/features).

### Languages

Due to a large demand and lack of time, as a general rule, we aim to support the latest (or most popular) officially supported versions of languages.

#### NodeJS

> Production applications should only use Active LTS or Maintenance LTS releases.
See https://nodejs.org/en/about/releases/ for the officially supported NodeJS Versions. We aim to support Active LTS or Maintenance LTS versions with a best-effort support for Current versions.

Support priority:

1. Active LTS
2. Maintenance LTS
3. Current

0 comments on commit 8a7310a

Please sign in to comment.