Put changelog in `./docs`

This commit is contained in:
Jia Hao 2016-03-14 00:35:46 +08:00
parent 09e5d3b7c7
commit 08575ca75f
3 changed files with 22 additions and 15 deletions

View File

@ -19,8 +19,9 @@ You're done.
- [Installation](#installation)
- [Usage](#usage)
- [Optional Dependencies](#optional-dependencies)
- [API](docs/api.md)
- [How It Works](#how-it-works)
- [API Documentation](docs/api.md)
- [Changelog](docs/changelog.md)
- [Development](docs/development.md)
- [License](#license)
@ -30,7 +31,7 @@ Nativefier is a command line tool that allows you to easily create a desktop app
I did this because I was tired of having to `⌘-tab` or `alt-tab` to my browser and then search through the numerous open tabs when I was using [Facebook Messenger](http://messenger.com) or [Whatsapp Web](http://web.whatsapp.com).
View the changelog [here](https://github.com/jiahaog/nativefier/blob/master/History.md).
View the changelog [here](docs/changelog.md).
[Relevant Hacker News Thread](https://news.ycombinator.com/item?id=10930718)
@ -104,11 +105,15 @@ In addition, I built [GitCloud](https://github.com/jiahaog/gitcloud) to use GitH
## API Documentation
See [API](docs/api.md)
See [API](docs/api.md).
## Changelog
See [Changelog](docs/changelog.md).
## Development
See [Development](docs/development.md)
See [Development](docs/development.md).
## License

View File

@ -1,3 +1,4 @@
# Changelog
6.11.0 / 2016-03-11
===================

View File

@ -8,30 +8,31 @@ At branch `development` ready to release to npm:
``` bash
# Make sure ci tests pass
$ npm run ci
npm run ci
# See the current version
$ npm version
npm version
# Update the changlog and perform cleanup on it
$ git changelog --tag <next version>
git changelog docs/changelog.md --tag <next version>
subl docs/changelog.md
$ git add History.md
$ git commit -m "Update changelog for `v <next version>`"
git add docs/changelog.md
git commit -m "Update changelog for `v <next version>`"
$ npm version <next version>
npm version <next version>
# Can automate from here onwards
# Publish it to npm
$ npm run release
npm run release
# Merge changes into master
$ git checkout master
$ git merge development
git checkout master
git merge development
$ git push --follow-tags
git push --follow-tags
# Return to development
$ git checkout development
git checkout development
```