diff --git a/.bumpversion.cfg b/.bumpversion.cfg index b902328..88579f4 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 1.3.2 +current_version = 1.3.3 [bumpversion:file:tw-plugin/plugin.info] @@ -10,3 +10,7 @@ current_version = 1.3.2 [bumpversion:file:anki-plugin/src/util.py] search = PLUGIN_VERSION = "{current_version}" replace = PLUGIN_VERSION = "{new_version}" + +[bumpversion:file:ankiweb-description.html] +search = TiddlyRemember version {current_version} +replace = TiddlyRemember version {new_version} diff --git a/LICENSE b/LICENSE index 74f040e..4011b12 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) 2020-2021 Soren Bjornstad and the TiddlyRemember community. +Copyright (c) 2020-2022 Soren Bjornstad and the TiddlyRemember community. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/RELEASING.md b/RELEASING.md index 698f207..6ad3d66 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -9,8 +9,15 @@ Since Anki doesn't have any way to deploy plugins through CD, Aside from straight bugfix releases, the docs should be updated with every release. -In order to perform edits, - first, edit the `docs/tiddlywiki.info` as follows: +In order to perform edits: + + +```bash +cp docs/tiddlywiki.info{,.old}; jq '.plugins = ["tiddlywiki/filesystem", "tiddlywiki/tiddlyweb"]' docs/tiddlywiki.info.old >docs/tiddlywiki.info; cd docs && tiddlywiki --listen +``` + +This is the automatic version of editing the `docs/tiddlywiki.info` as follows +and running the server so you can edit in your browser: ```json "plugins": [ @@ -19,35 +26,24 @@ In order to perform edits, ], ``` -Then cd into the `docs/` directory -and run `tiddlywiki --listen`. -You can now edit freely in your browser. -Roll back the `tiddlywiki.info` changes, - commit the rest of your changes, - and you're set. - -*Suggestion for improvement*: - Provide a way to use a different `tiddlywiki.info`, - or to automatically remove those plugins on a production build, - to avoid having to manually change it all the time. - +Don't stop the listener until you're told to do so by a later step +(or run the snippet again starting from `jq` to get the server restarted if you take a break). ## Bumping the version -1. Update the version number in: - * `tw-plugin/plugin.info`. - * The `TiddlyWiki Metadata` tiddler. - * `util.py` (both the TR compatibility list and the plugin version). - * The `TiddlyRememberParseable` template. -2. Open and save the `TiddlyRemember` main tiddler +1. Open and save the `TiddlyRemember` main tiddler so that its modification date gets bumped. -3. Quit the TiddlyWiki listener. +2. Run `bumpversion patch` (or `minor` or `major` if needed). +3. Check and update the `COMPATIBLE_TW_VERSIONS` array + in `anki-plugin/src/util.py`. +4. Check and update the `compatible-tw5` and `compatible-anki` properties + in `docs/tiddlers/TiddlyRemember Metadata.json`. ## Updating the Anki add-on 1. Update the add-on description in `ankiweb-description.html`, - including a brief changelog message. + including a brief changelog message and the release date. Don't forget to bump the version number presented. Remember that the AnkiWeb description page has *significant whitespace*, terribly enough. @@ -62,12 +58,14 @@ Roll back the `tiddlywiki.info` changes, ## Publishing to GitHub -1. Commit all doc and release changes made thus far. -2. Check your branch log and make any final rebases or adjustments. -3. Push the branch to GitHub. -4. Create a pull request to `master`. +1. Quit the TiddlyWiki listener (hit Ctrl+C on the big PasteOps command from above). + Run `cd -; mv docs/tiddlywiki.info.old docs/tiddlywiki.info` to restore the file. +2. Commit all doc and release changes made thus far. +3. Check your branch log and make any final rebases or adjustments. +4. Push the branch to GitHub. +5. Create a pull request to `master`. If all looks good, complete with a rebase-and-merge and delete the branch. -5. Create a new release on GitHub to publicize the update: +6. Create a new release on GitHub to publicize the update: https://github.com/sobjornstad/TiddlyRemember/releases/new. The tag should be in the form `v0.0.0`, using standard semantic versioning. Hold off on publishing the release for the moment. diff --git a/anki-plugin/src/util.py b/anki-plugin/src/util.py index 11eaab2..8f5363e 100644 --- a/anki-plugin/src/util.py +++ b/anki-plugin/src/util.py @@ -11,8 +11,8 @@ Twid = NewType('Twid', str) DEFAULT_FILTER = '[type[text/vnd.tiddlywiki]] [type[]] +[!is[system]]' -PLUGIN_VERSION = "1.3.2" -COMPATIBLE_TW_VERSIONS = ["", "1.2.2", "1.2.3", "1.3.0", "1.3.1", "1.3.2"] +PLUGIN_VERSION = "1.3.3" +COMPATIBLE_TW_VERSIONS = ["", "1.2.2", "1.2.3", "1.3.0", "1.3.1", "1.3.2", "1.3.3"] def pluralize(sg: str, n: int, pl: str = None) -> str: diff --git a/ankiweb-description.html b/ankiweb-description.html index 9c1d245..88be329 100644 --- a/ankiweb-description.html +++ b/ankiweb-description.html @@ -1,6 +1,6 @@ TiddlyRemember is a tool that integrates TiddlyWiki with Anki. You can interleave questions with your notes in TiddlyWiki, then sync them into Anki notes with one click. You can edit and move the questions around your TiddlyWiki, and they will stay connected to the Anki notes. Scheduling information in Anki is preserved when editing notes in TiddlyWiki. -This is TiddlyRemember version 1.3.2, released December 18, 2021. +This is TiddlyRemember version 1.3.3, released January 6, 2021. @@ -11,11 +11,12 @@ Changelog: -