Skip to content

Commit

Permalink
bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
sobjornstad committed Jan 6, 2022
1 parent f9e709f commit fb04608
Show file tree
Hide file tree
Showing 11 changed files with 77 additions and 74 deletions.
6 changes: 5 additions & 1 deletion .bumpversion.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 1.3.2
current_version = 1.3.3

[bumpversion:file:tw-plugin/plugin.info]

Expand All @@ -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}
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -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
Expand Down
52 changes: 25 additions & 27 deletions RELEASING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -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.
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions anki-plugin/src/util.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
13 changes: 7 additions & 6 deletions ankiweb-description.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
TiddlyRemember is a tool that integrates <a href="https://tiddlywiki.com" rel="nofollow">TiddlyWiki</a> 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.

<ul><li><b>Documentation</b>: <a href="https://sobjornstad.github.io/TiddlyRemember/" rel="nofollow">https://sobjornstad.github.io/TiddlyRemember/</a></li>
<li><b>Bug reports and feature requests</b>: <a href="https://github.com/sobjornstad/TiddlyRemember/issues" rel="nofollow">https://github.com/sobjornstad/TiddlyRemember/issues</a>, or email [email protected].</li></ul>
Expand All @@ -11,11 +11,12 @@

<b>Changelog:</b>

<ul><li><b>1.3.2</b>: Fixed several bugs in error handling which prevented the root cause of an issue from being accurately reported.
<li><b>1.3.1</b>: Fixed a bug where file wikis could not sync images that were embedded in the wiki.
<li><b>1.3.0</b>: Many new features, including media syncing, math markup, brace escapes, initial scheduling information, and reading encrypted wikis.
<li><b>1.2.3</b>: Anki 2.1.45 support. Fix the <i>remembercz</i> macro accidentally changing the current tiddler.
<li><b>1.2.2</b>: Miscellaneous bugfixes, including permalinks with spurious / at the end and friendlier error messages.
<ul><li><b>1.3.3</b>: Add support for Qt 6 and Anki 2.1.50 (in beta at the time of this release).</li>
<li><b>1.3.2</b>: Fixed several bugs in error handling which prevented the root cause of an issue from being accurately reported.</li>
<li><b>1.3.1</b>: Fixed a bug where file wikis could not sync images that were embedded in the wiki.</li>
<li><b>1.3.0</b>: Many new features, including media syncing, math markup, brace escapes, initial scheduling information, and reading encrypted wikis.</li>
<li><b>1.2.3</b>: Anki 2.1.45 support. Fix the <i>remembercz</i> macro accidentally changing the current tiddler.</li>
<li><b>1.2.2</b>: Miscellaneous bugfixes, including permalinks with spurious / at the end and friendlier error messages.</li>
<li><b>1.2.1</b>: Fixed a bug where wikis retrieved from URLs would sometimes produce garbled notes. Only the Anki side was updated in this release, so you do not need to update your TiddlyWiki plugin.</li>
<li><b>1.2.0</b>: Most HTML formatting is now preserved when importing into Anki. A new "pair" note type, which works similarly to "Basic (and reversed card)", is now available. Several bugs fixed.</li>
<li><b>1.1.1</b>: Fixed a bug introduced in version 1.0.1 where tiddler titles were not URL-decoded when necessary, leading to garbage in the Reference field.</li>
Expand Down
2 changes: 1 addition & 1 deletion docs/tiddlers/TiddlyRemember Metadata.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"version": "1.3.2",
"version": "1.3.3",
"compatible-tw5": ">= 5.1.21",
"compatible-anki": ">= 2.1.45",
"repository": "https://github.com/sobjornstad/TiddlyRemember",
Expand Down
2 changes: 1 addition & 1 deletion docs/tiddlers/TiddlyRemember.tid
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
created: 20200523154559237
list: [[Installing TiddlyRemember]] [[Configuring TiddlyRemember]] [[Creating notes in TiddlyRemember]] [[Syncing TiddlyRemember with Anki]] [[Video Introduction]] Troubleshooting
modified: 20211218170739751
modified: 20220106170003666
title: TiddlyRemember
type: text/vnd.tiddlywiki

Expand Down
64 changes: 32 additions & 32 deletions docs/tiddlywiki.info
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
{
"description": "TiddlyRemember",
"plugins": [
"description": "TiddlyRemember",
"plugins": [
],
"themes": [
"tiddlywiki/vanilla"
],
"build": {
"index": [
"--rendertiddler",
"$:/core/save/all",
"index.html",
"text/plain"
],
"themes": [
"tiddlywiki/vanilla"
],
"build": {
"index": [
"--rendertiddler",
"$:/core/save/all",
"index.html",
"text/plain"
],
"static": [
"--rendertiddler",
"$:/core/templates/static.template.html",
"static.html",
"text/plain",
"--rendertiddler",
"$:/core/templates/alltiddlers.template.html",
"alltiddlers.html",
"text/plain",
"--rendertiddlers",
"[!is[system]]",
"$:/core/templates/static.tiddler.html",
"static",
"text/plain",
"--rendertiddler",
"$:/core/templates/static.template.css",
"static/static.css",
"text/plain"
]
}
"static": [
"--rendertiddler",
"$:/core/templates/static.template.html",
"static.html",
"text/plain",
"--rendertiddler",
"$:/core/templates/alltiddlers.template.html",
"alltiddlers.html",
"text/plain",
"--rendertiddlers",
"[!is[system]]",
"$:/core/templates/static.tiddler.html",
"static",
"text/plain",
"--rendertiddler",
"$:/core/templates/static.template.css",
"static/static.css",
"text/plain"
]
}
}
2 changes: 1 addition & 1 deletion pylintrc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ profile=no
# Add files or directories to the blacklist. They should be base names, not
# paths.
ignore=venv
ignore-patterns=.*dialog.py
ignore-patterns=.*_dialog.*\.py

# Pickle collected data for later comparisons.
persistent=yes
Expand Down
2 changes: 1 addition & 1 deletion tw-plugin/plugin.info
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"title": "$:/plugins/sobjornstad/TiddlyRemember",
"description": "TiddlyRemember: Embed Anki notes in your TiddlyWiki",
"author": "Soren Bjornstad",
"version": "1.3.2",
"version": "1.3.3",
"core-version": ">=5.1.21",
"source": "https://github.com/sobjornstad/TiddlyRemember",
"list": "readme license",
Expand Down
2 changes: 1 addition & 1 deletion tw-plugin/templates/TiddlyRememberParseable.tid
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type: text/vnd.tiddlywiki

<$set name="tr-rendering" value="yes">

<span id="tr-version">1.3.2</span>
<span id="tr-version">1.3.3</span>

{{||$:/plugins/sobjornstad/TiddlyRemember/templates/AnkiDecks}}
{{||$:/plugins/sobjornstad/TiddlyRemember/templates/AnkiTags}}
Expand Down

0 comments on commit fb04608

Please sign in to comment.