Release procedure
- gulp prepare-release --bump minor
instead ofminor,major|minor|patch|prereleaseare also valid options - push the changes to master
- create release tag in Github (add most important changes, such as breaking changes/added features/fixed bugs to the description from the changelog)
- run
npm publish(note: NPM credentials are required) - continue with https://github.com/aurelia-ui-toolkits/demo-kendo#how-to-deploy-from-samples
- continue with https://github.com/aurelia-ui-toolkits/aurelia-kendoui-bundles#instructions
Aurelia-Toolkits release process is slightly different from the process used by Aurelia core team. We always create the release from the master branch of aurelia-kendoui-bridge. Since we maintain new development in branches named after repository milestones (here is the milestone 0.6.0 showing that adriatic is developing QR Code and Splitter components):
Image 1
it means that before releasing any new version, we need to merge the related branch into master. In the above example, we would have to merge branch 0.6.0 into the master before starting to create the release. See this document for more details on merging
(Taking place in the context of the local clone of the repository that is being released.)
Ensure that the master branch is set (it's the branch being released).
λ git checkout master
Switched to branch 'master'
Your branch is up-to-date with 'origin/master'.
Run the gulp prepare-release --bump minor command
λ gulp prepare-release --bump minor
[09:48:08] Using gulpfile C:\work\aurelia-ui-toolkits\KendoUI\aurelia-kendoui-bridge\gulpfile.js
[09:48:08] Starting 'prepare-release'...
[09:48:08] Starting 'build-release'...
[09:48:08] Starting 'clean'...
[09:48:08] Finished 'clean' after 95 ms
[09:48:08] Starting 'build-index'...
[09:48:08] Finished 'build-index' after 62 ms
[09:48:08] Starting 'build-es6-temp'...
[09:48:08] Starting 'build-es6'...
[09:48:08] Starting 'build-commonjs'...
[09:48:08] Starting 'build-amd'...
[09:48:08] Starting 'build-system'...
[09:48:10] Finished 'build-es6-temp' after 1.64 s
[09:48:15] Finished 'build-es6' after 6.51 s
[09:48:15] Finished 'build-amd' after 6.53 s
[09:48:15] Finished 'build-commonjs' after 6.54 s
[09:48:15] Finished 'build-system' after 6.58 s
[09:48:15] Starting 'copy-html'...
[09:48:15] Starting 'copy-css'...
[09:48:15] Starting 'copy-json'...
[09:48:15] Finished 'copy-css' after 13 ms
[09:48:15] Finished 'copy-json' after 12 ms
[09:48:15] Finished 'copy-html' after 65 ms
[09:48:15] Starting 'build-dts'...
[09:48:15] Finished 'build-dts' after 21 ms
[09:48:15] Finished 'build-release' after 6.84 s
[09:48:15] Starting 'lint'...
[09:48:23] Finished 'lint' after 7.7 s
[09:48:23] Starting 'bump-version'...
[09:48:23] Bumped 'package.json' version to: 0.3.0
[09:48:23] Finished 'bump-version' after 57 ms
[09:48:23] Starting 'doc'...
[09:48:23] Starting 'doc-generate'...
[09:48:25]
TypeDoc 0.3.12
Using TypeScript 1.6.2 from C:\work\aurelia-ui-toolkits\KendoUI\aurelia-kendoui-bridge\node_modules\typescript\lib
[09:48:29] Finished 'doc-generate' after 5.93 s
[09:48:29] Starting 'doc-extract'...
[09:48:29] Finished 'doc-extract' after 65 ms
[09:48:29] Finished 'doc' after 6 s
[09:48:29] Starting 'changelog'...
0.3.0
[09:48:29] Finished 'changelog' after 265 ms
[09:48:29] Finished 'prepare-release' after 21 s
Verify that the release number is correct - as shown on the screenshot bellow
Image 2
push the changes to master (Taking place in the context of the local clone of the repository that is being released.)
This step is executed using the GitHub desktop client - as shown below:
Image 3
Now, verify the content of this set of changes by inspecting the content of the file docs/changelog.md generated by the gulp prepare-release --bump minor command
Image 4
Click on Commit to master button and once the commit is confirmed, click on the Sync button to push all these changes to GitHub origin repository.
create release tag in Github This step is described with all details here. The few relevant screenshots follow below:
Image 5
Click on the releases link (9 releases as shown above) results with
Image 6
Now, click on Draft a new release button - and get the screenshot below, where we set the tag name 0.3.0 and the release title (again 0.3.0)
Image 7
In the release description enter the release text that was generated into doc/CHANGELOG.md
This text is taken from the release process changelog document and pasted in the "Describe the release text box" shown on Image 7 above
λ npm login
Username: aurelia-kendoui-bridge
Password:
Email: (this IS public) ixxx@bbbbbbb
Note that both password and email are considered a part of npm credentials, so we do not show that data here
C:\work\aurelia-ui-toolkits\KendoUI\aurelia-kendoui-bridge (master)
λ npm publish
+ [email protected]