Add manifest.json #186
Merged
Add manifest.json #186
Conversation
This file contains 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
I do not think that keeping manifest.json in the source tree has any disadvantages (e.g. for manual install or for uploading to AnkiWeb). Having a manifest.json allows users to install the zipped add-on via the new-ish "sharing outside ankiweb" install process[0]. Not all the fields are specified in the docs, but they can be sleuthed by inspecting Anki's source code[1]. It _might_ make sense for `mod` and `human_version`, to be updated automatically, when releasing, or we could just drop them. If we ever have beta builds, the conflicts field could allow the release builds to conflict with the beta builds (and vice-versa), to allow users a way to quickly and easily switch. A positive max_point_version does not indicate maximum 2.1.x compatible Anki version, but the highest version tested. [0] https://addon-docs.ankiweb.net/sharing.html#sharing-outside-ankiweb [1] https://github.com/ankitects/anki/blob/ c32f14f7cbc9461e35548afa5b42c5424606008f/qt/aqt/addons.py#L186
`mod` and `human_version` could be added automatically during release, with `date "+%s"` and `git describe`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I do not think that keeping manifest.json in the source tree has any disadvantages (e.g. for manual install or for uploading to AnkiWeb). Having a manifest.json allows users to install the zipped add-on via the new-ish "sharing outside ankiweb" install process[0].
Not all the fields are specified in the docs, but they can be sleuthed by inspecting Anki's source code[1].
It might make sense for
modandhuman_version, to be updated automatically, when releasing, or we could just drop them.If we ever have beta builds, the conflicts field could allow the release builds to conflict with the beta builds (and vice-versa), to allow users a way to quickly and easily switch.
A positive max_point_version does not indicate maximum 2.1.x compatible Anki version, but the highest version tested.
[0] https://addon-docs.ankiweb.net/sharing.html#sharing-outside-ankiweb
[1] https://github.com/ankitects/anki/blob/c32f14f7cbc9461e35548afa5b42c5424606008f/qt/aqt/addons.py#L186
For the moment I manually added a manifest.json to the latest release.