Scripts for building tiddlywiki.com
These scripts are used to build and release the content for tiddlywiki.com. They are not designed for general purpose use – they resolve problems that are specific to the task of building tiddlywiki.com: pushing to GitHub Pages, handling the prerelease builds and bumping version numbers.
Nonetheless, you may find techniques that are useful for your own scripts.
The scripts live in the repository https://github.com/Jermolene/build.jermolene.github.io
These scripts require the following directories to be siblings:
build.jermolene.github.io- a local copy of https://github.com/Jermolene/build.jermolene.github.io
jermolene.github.io- a local copy of the repo https://github.com/Jermolene/jermolene.github.io
TiddlyWiki5- a local copy of the repo https://github.com/Jermolene/TiddlyWiki5
The scripts are designed to be executed with the current directory being the
package.json in the root of the
build.jermolene.github.io repository contains a dependency declaration that specifies the latest official released version of TiddlyWiki to be used when building the release targets:
Some of the scripts use the following environment variables:
- TW5_BUILD_MAIN_EDITION - the path to the wiki folder to be used as the main edition, generating
- TW5_BUILD_OUTPUT - the path to the output folder (defaults to
- TW5_BUILD_TIDDLYWIKI - the pathname of the
tiddlywiki.jsto be used (defaults to
tiddlywiki.com target files. By default, it uses the version of tiddlywiki specified in the
package.json file. This can be overridden with the TW5_BUILD_TIDDLYWIKI environment variable. The following command would select the latest prerelease version of tiddlywiki from the
Builds the readme files for the
build.jermolene.github.io repos using the released version of TiddlyWiki specified in
tiddlywiki.com/prerelease target files using the latest TiddlyWiki prerelease code and special prerelease edition for the content.
Pushes the latest changes to the
jermolene.github.io directory to GitHub.
Builds the dev prerelease edition.
Builds the prerelease prerelease edition.
Builds the tw5tiddlyweb edition and uploads it to TiddlySpace.
Bumps the version number of the
package.json in the
TiddlyWiki5 repo and applies the correct version tag to the repo.
TiddlyWiki5 repo to npm.
Releasing a new version of TiddlyWiki
Preparation on master
- Ensure the new release banner image is up to date
- Update master with changes from tiddlywiki-com
- Verify the version numbers in $:/config/OfficialPluginLibrary in
- Move the latest release note from the prerelease edition into the tw5.com edition
- Adjust the release date and the released field of the latest release tiddler (eg, Release 5.1.3)
- Also adjust the github.com comparison link to point to the tag for the new release
- Ensure TiddlyWiki Releases has the new version as the default tab
- Adjust the modified time of HelloThere
- Make sure master is fully committed
package.jsonto the new version number
./bin/readme-bld.shto build the readme files
- Commit the new readme files to master
package.jsonto the previous version number
Make New Release
./bin/verbump "5.1.3"(substituting the correct version number) to update the version number, assign it a tag
./bin/npm-publish.shto publish the release to npm
- Verify that the new release of TiddlyWiki is available at https://www.npmjs.org/package/tiddlywiki
Update tiddlywiki.com release
- Update tiddlywiki-com from master and push to GitHub
- Tweet the release with the text "TiddlyWiki v5.x.x released to https://tiddlywiki.com #newtiddlywikirelease"
Preparation for the next release in master
- Adjust version number in
- Adjust version number in
- Adjust version number in $:/config/OfficialPluginLibrary (both in
editions/prerelease/tiddlers/system) and $:/config/LocalPluginLibrary
- Adjust new release banner
- Create the release note for the new release
- Commit changes to master and push to GitHub
Releasing new content for TiddlyWiki
To update https://tiddlywiki.com with new content, make a Pull Request with the updated tiddlers to the
tiddlywiki-com branch. As soon as the PR is merged, the Continuous Deployment system will automatically rebuild the site.
Note that the PR should only include updates within the
editions folder of the repo.