chore(release): 3.0.0 - #115
Merged
Merged
Conversation
The v2 Track API this plugin registers with shipped in Signal K server 2.33.0, so the 3.x line leaves prerelease. The README now states what that means for someone reading it before installing: 2.33.0 or newer serves the v2 Track API, older servers serve the v1 routes alone. The plugin does not require it -- `registerTrackApiProvider` is called optionally and its absence is neither an error nor a warning -- so an older server keeps a working plugin rather than a broken one. What the 3.x line brought: tracks recorded to SQLite so they survive a restart with no other plugin, reconciliation with an installed history provider per query, a webapp with GPX import and export, glitch filtering, Douglas-Peucker simplification, remembered vessel names, and v1 routes that reject a query they cannot honour rather than answering 200 with something else.
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Repository: SignalK/tracks/.coderabbit.yaml Review profile: ASSERTIVE Plan: Advanced Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The v2 Track API this plugin registers with shipped in Signal K server 2.33.0, so the 3.x line leaves prerelease.
Verified against the
v2.33.0tag rather than the release note:src/api/tracks/andregisterTrackApiProviderare present, andstoreTrack/deleteTrackare not — the read-only API, which is what this plugin needs.The README now says what a reader needs before installing
Worth being precise about "requires", because the plugin does not hard-require it.
registerTrackApiProvideris called optionally (app.registerTrackApiProvider?.(...)) and its absence is neither an error nor a warning —trackProvider.test.tscovers a server without it and asserts the plugin starts clean and logs nothing. So an older server keeps a working plugin: v1 routes, webapp, GPX export, SQLite store. What it does not get is/signalk/v2/api/tracks.Stating a flat "requires 2.33.0" would have told someone on 2.32 to uninstall a plugin that works for them.
What the 3.x line brought
Tracks recorded to SQLite so they survive a restart with no other plugin; reconciliation with an installed history provider per query; a webapp with GPX import and export; glitch filtering; Douglas-Peucker simplification; remembered vessel names; and v1 routes that reject a query they cannot honour rather than answering 200 with something else.
Note on the npm tag
This moves
latestfrom 2.1.0, where it has been through the whole beta line. Existing 2.x users will see 3.0.0 on their next update.Tested
568 unit tests pass; typecheck, eslint and prettier clean; build succeeds.