From fc2d3ce56a7fe764654905bbf69bb804fc802f53 Mon Sep 17 00:00:00 2001 From: Jermolene Date: Thu, 16 Oct 2014 09:27:25 +0100 Subject: [PATCH] Docs update --- .../Releasing a new version of TiddlyWiki.tid | 3 +- .../Releasing new content for TiddlyWiki.tid | 2 ++ .../Scripts for building tiddlywiki.com.tid | 30 +++++++++++++++++-- 3 files changed, 32 insertions(+), 3 deletions(-) diff --git a/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid b/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid index b033f6946..073c32cbb 100644 --- a/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid +++ b/editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid @@ -9,7 +9,8 @@ title: Releasing a new version of TiddlyWiki # Run `../build.jermolene.github.io/readme-bld.sh` to build the readme files # Commit the new readme files in `TiddlyWiki5` and `build.jermolene.github.io` # Restore `package.json` to the previous version number -# Run `../build.jermolene.github.io/verbump "5.1.3"` (substituting the correct version number) to update the version number, assign it a tag and publish the release to npm +# Run `../build.jermolene.github.io/verbump "5.1.3"` (substituting the correct version number) to update the version number, assign it a tag +# Run `../build.jermolene.github.io/npm-publish.sh` to publish the release to npm # Verify that the new release of TiddlyWiki is available at https://www.npmjs.org/package/tiddlywiki # Check the version number of TiddlyWiki specified in `build.jermolene.github.io/package.json` is the latest version # Change current directory to the `build.jermolene.github.io` directory diff --git a/editions/dev/tiddlers/build/Releasing new content for TiddlyWiki.tid b/editions/dev/tiddlers/build/Releasing new content for TiddlyWiki.tid index 6b61c8596..662fbdf41 100644 --- a/editions/dev/tiddlers/build/Releasing new content for TiddlyWiki.tid +++ b/editions/dev/tiddlers/build/Releasing new content for TiddlyWiki.tid @@ -2,5 +2,7 @@ title: Releasing new content for TiddlyWiki # Change current directory to the `TiddlyWiki5` directory # Run `../build.jermolene.github.io/bld.sh` to build the content files +# Run `../build.jermolene.github.io/readme-bld.sh` to build the readmes +# Commit the readmes to `TiddlyWiki5` and `build.jermolene.github.io` if necessary # Verify that the files in the `jermolene.github.io` directory are correct # Run `../build.jermolene.github.io/github-push.sh` to push the new files to GitHub diff --git a/editions/dev/tiddlers/build/Scripts for building tiddlywiki.com.tid b/editions/dev/tiddlers/build/Scripts for building tiddlywiki.com.tid index d459e5ab8..c78b80d26 100644 --- a/editions/dev/tiddlers/build/Scripts for building tiddlywiki.com.tid +++ b/editions/dev/tiddlers/build/Scripts for building tiddlywiki.com.tid @@ -1,6 +1,8 @@ title: 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, but you may find techniques that are useful for your own scripts. +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. ! Hosting @@ -14,7 +16,7 @@ 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/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 `TiddlyWiki5` directory. @@ -49,6 +51,10 @@ Builds the `tiddlywiki.com` target files. By default, it uses the version of tid TW5_BUILD_TIDDLYWIKI=./tiddlywiki.js ``` +!! `readme-bld.sh` + +Builds the readme files for the `TiddlyWiki5` and `build.jermolene.github.io` repos using the released version of TiddlyWiki specified in `package.json`. + !! `prerelease-bld.sh` Builds the `tiddlywiki.com/prerelease` target files using the latest TiddlyWiki prerelease code and special ''prerelease'' edition for the content. @@ -57,6 +63,26 @@ Builds the `tiddlywiki.com/prerelease` target files using the latest TiddlyWiki Pushes the latest changes to the `jermolene.github.io` directory to GitHub. +!! `dev-bld.sh` + +Builds the ''dev'' prerelease edition. + +!! `quick-bld.sh` + +Builds the ''prerelease'' prerelease edition. + +!! `tiddlyspace-upload.sh` + +Builds the ''tw5tiddlyweb'' edition and uploads it to TiddlySpace. + +!! `verbump.sh` + +Bumps the version number of the `package.json` in the `TiddlyWiki5` repo and applies the correct version tag to the repo. + +!! `npm-publish.sh` + +Publishes the `TiddlyWiki5` repo to npm. + ! Procedures !! Releasing a new version of TiddlyWiki