mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-23 18:17:20 +00:00
Code Issues Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
Jermolene 2014-10-16 09:27:25 +01:00
parent dcc33e52b3
commit fc2d3ce56a
3 changed files with 32 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
editions/dev/tiddlers/build/Releasing a new version of TiddlyWiki.tid
View File

@ -9,7 +9,8 @@ title: Releasing a new version of TiddlyWiki
# Run `../build.jermolene.github.io/readme-bld.sh` to build the readme files # 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` # Commit the new readme files in `TiddlyWiki5` and `build.jermolene.github.io`
# Restore `package.json` to the previous version number # 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 # 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 # 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 # Change current directory to the `build.jermolene.github.io` directory

2
editions/dev/tiddlers/build/Releasing new content for TiddlyWiki.tid
View File

@ -2,5 +2,7 @@ title: Releasing new content for TiddlyWiki
# Change current directory to the `TiddlyWiki5` directory # Change current directory to the `TiddlyWiki5` directory
# Run `../build.jermolene.github.io/bld.sh` to build the content files # 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 # 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 # Run `../build.jermolene.github.io/github-push.sh` to push the new files to GitHub

30
editions/dev/tiddlers/build/Scripts for building tiddlywiki.com.tid
View File

@ -1,6 +1,8 @@
title: Scripts for building tiddlywiki.com 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 ! 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 * `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 * `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. 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 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` !! `prerelease-bld.sh`
Builds the `tiddlywiki.com/prerelease` target files using the latest TiddlyWiki prerelease code and special ''prerelease'' edition for the content. 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. 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 ! Procedures
!! Releasing a new version of TiddlyWiki !! Releasing a new version of TiddlyWiki