mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-24 00:50:28 +00:00
Code Issues Releases Wiki Activity

Docs: Update the build docs

Browse Source
This commit is contained in:
Jeremy Ruston 2019-08-09 14:08:13 +01:00
parent 9244a2f4fd
commit 762810361f
2 changed files with 30 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -1,27 +1,35 @@
created: 20190809095728085
modified: 20190809123445125
title: Releasing a new version of TiddlyWiki
type: text/vnd.tiddlywiki
# Verify the version numbers in [[$:/config/OfficialPluginLibrary]] (both in `editions/tw5.com` and `editions/prerelease/tiddlers/system`)
!! Preparation on master
# Update `master` from `tiddlywiki-com`
# Verify the version numbers in [[$:/config/OfficialPluginLibrary]] in `editions/tw5.com`
# 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]])
# Ensure [[TiddlyWiki Releases]] has the new version as the default tab
# Adjust the modified time of HelloThere
# Make sure ''Jermolene/TiddlyWiki5'' is fully committed
# Make sure ''Jermolene/TiddlyWiki5-master'' is fully committed
!! Update Readmes
# Edit `package.json` to the new version number
# Run `../build.jermolene.github.io/readme-bld.sh` to build the readme files
# Commit the new readme files in `TiddlyWiki5`
# Run `./bin/readme-bld.sh` to build the readme files
# Commit the new readme files to `master`
# 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
# Run `../build.jermolene.github.io/npm-publish.sh` to publish the release to npm
# Update the `package.json` for `build.jermolene.github.io` to the new version
!! Make New Release
# Run `./bin/verbump "5.1.3"` (substituting the correct version number) to update the version number, assign it a tag
# Run `./bin/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
# Change current directory to the `build.jermolene.github.io` directory
# Run `npm install` to install the correct version of TiddlyWiki
# Change current directory to the `TiddlyWiki5` directory
# Run `../build.jermolene.github.io/bld.sh` to build the content files
# 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
# Tweet the release with the text "TiddlyWiki v5.x.x released to https://tiddlywiki.com #newtiddlywikirelease"
# Preparation for the next release:
## Adjust version number in [[$:/config/OfficialPluginLibrary]] (both in `editions/tw5.com` and `editions/prerelease/tiddlers/system`) and [[$:/config/LocalPluginLibrary]]
## Adjust version number in https://github.com/Jermolene/build.jermolene.github.io in `prerelease-bld.sh`, `bld.sh` and `make-library-bld.sh`
!! Preparation for the next release
# Adjust version number in package.json
# Adjust version number in [[$:/config/OfficialPluginLibrary]] (both in `editions/tw5.com` and `editions/prerelease/tiddlers/system`) and [[$:/config/LocalPluginLibrary]]
# Create the release note for the new release
# Adjust version number in https://github.com/Jermolene/build.jermolene.github.io in `prerelease-bld.sh`, `bld.sh` and `make-library-bld.sh`

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

@ -1,8 +1,8 @@
created: 20190809094421578
modified: 20190809104210288
title: Releasing new content for TiddlyWiki
type: text/vnd.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
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.