diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..16e5508b34 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,100 @@ +#### 0.0.9 (2016-12-11) + +##### Documentation Changes + +* **packager:** document the require mapping of the hooks (87fb6aa6) + +##### New Features + +* **packager:** map afterExtract hooks to require calls (623a0001) + +#### 0.0.8 (2016-12-11) + +##### New Features + +* **maker:** add the flatpak maker for the linux target (218518ef) + +##### Refactors + +* **packager:** + * move packager compile logic to a electron-packager afterCopy hook (c10bcd29) + * upgrade to Electron Packager 8.4.0 (with quiet option) (9ab19b5f) + +#### 0.0.7 (2016-12-11) + +##### Documentation Changes + +* **generic:** + * tweak the readme (c6ededf6) + * update readme (f03ffeb5) + +##### Bug Fixes + +* **starter:** pass through env to started application (834729fb) +* **maker:** spawn the zip command in the containing directory (e909a0c4) +* **initializer:** add electron-compile to the prod dependencies of the initialized app (5a56efb9) + +#### 0.0.6 (2016-12-11) + +##### Chores + +* **tests:** + * run different package installers in different Travis workers (028bcfbf) + * run Travis with OSX and Linux workers (9d1b0291) + +##### Documentation Changes + +* **README:** + * fix license badge url (026141c0) + * add badges to the readme (f912c24f) +* **LICENSE:** add a license file (89ada6e9) + +##### New Features + +* **maker:** + * add the rpm maker for the linux target (85821f27) + * add the deb maker for the linux target (5c5ce67a) + * add the dmg maker for the darwin target (aaceb3f2) +* **build:** add git-cz for semantic versioned commits (cdbc78b6) + +##### Bug Fixes + +* **maker:** + * add a santizied app id to the electronWinstaller config on init (20ae889e) + * move electron-installer-debian to optional deps so that installs work on windows (661b1eb6) + * correct path/arch of generated deb file (63ff52b2) +* **generic:** fix package.json warning about repository (f21a87aa) +* **packager:** throw error when electron-prebuilt-compile is not found (23449956) + +##### Refactors + +* **maker:** + * DRY up app name (f5ae494f) + * add packageJSON to the function arguments (e8e1054a) + * create ensure{Directory,File} to rimraf+mkdirp the given output (b3b616a0) +* **generic:** + * add debug calls to the linter (3e116109) + * add the 'debug' module for standard debug logging (9f4c0b49) +* **packager:** + * remove stray log (f4f36b59) + * move the electron-packager dependency to forge instead of the users module (2e695c21) + +##### Code Style Changes + +* **generic:** + * disable some eslint rules that don't make sense in a CLI tool (f1f06acf) + * change eslint rules to allow strange linebreaks (4b7a22e3) + +##### Tests + +* **resolve-dir:** add a fixture that is actually an electron-forge package.json file (e0e712dd) + +#### 0.0.5 (2016-12-11) + +#### 0.0.4 (2016-12-11) + +#### 0.0.3 (2016-12-11) + +#### 0.0.2 (2016-12-11) + +#### 0.0.1 (2016-12-11) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c42e993c45..e3d9a1f876 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,8 +66,6 @@ Here are some things to keep in mind as you file pull requests to fix bugs, add * One of the philosophies of the project is to keep the code base as small as possible. If you are adding a new feature, think about whether it is appropriate to go into a separate Node module, and then be integrated into this project. -* If you are contributing a nontrivial change, please add an entry to `NEWS.md`. The format is - similar to the one described at [Keep a Changelog](http://keepachangelog.com/). * Please **do not** bump the version number in your pull requests, the maintainers will do that. Feel free to indicate whether the changes require a major, minor, or patch version bump, as prescribed by the [semantic versioning specification](http://semver.org/). @@ -79,10 +77,7 @@ Here are some things to keep in mind as you file pull requests to fix bugs, add ### Release process - if you aren't sure if a release should happen, open an issue -- make sure that `NEWS.md` is up to date - make sure the tests pass -- `npm version ` -- `git push && git push --tags` (or `git push` with `git config --global push.followTags true` on latest git) -- create a new GitHub release from the pushed tag with the contents of `NEWS.md` for that version +- `npm run release:(patch|minor|major)` +- create a new GitHub release from the pushed tag with the contents of `CHANGELOG.md` for that version - close the milestone associated with the version if one is open -- `npm publish` diff --git a/NEWS.md b/NEWS.md deleted file mode 100644 index 7569163a02..0000000000 --- a/NEWS.md +++ /dev/null @@ -1,83 +0,0 @@ -# Changes by Version - -## Unreleased - -## [0.0.9] - 2016-12-10 - -### Added - -* Map Electron Packager `afterExtract` hooks to `require` calls - -## [0.0.8] - 2016-12-10 - -### Added - -* Flatpak support for the `make` subcommand (#6) - -## [0.0.7] - 2016-12-07 - -### Fixed - -* Add `electron-compile` to the prod dependencies of the initialized app -* Spawn the `zip` command in the containing directory -* Pass through parent environment to the started application - -## [0.0.6] - 2016-12-04 - -### Added - -* Windows.Squirrel support for `make` subcommand -* DMG support for the `make` subcommand -* Debian support for the `make` subcommand (#4) -* RPM support for the `make` subcommand - -### Fixed - -* Throw error when `electron-prebuilt-compile` not found (#2) - -## [0.0.5] - 2016-12-03 - -### Added - -* `make` subcommand, with support for zips - -### Fixed - -* Show linter error if Electron app not found - -## [0.0.4] - 2016-12-02 - -### Fixed - -* Launching an app via `start` - -## [0.0.3] - 2016-12-02 - -### Added - -* `forge` CLI alias -* Support for using `yarn` to install dependencies - -### Changed - -* Only support Node 6 -* Electron Packager is invoked via its API instead of its CLI - -## [0.0.2] - 2016-10-05 - -### Added - -* Debug logging when using the `start` subcommand - -## 0.0.1 - 2016-10-05 - -Initial release. - -[0.0.9]: https://github.com/MarshallOfSound/electron-forge/compare/v0.0.8...v0.0.9 -[0.0.8]: https://github.com/MarshallOfSound/electron-forge/compare/v0.0.7...v0.0.8 -[0.0.7]: https://github.com/MarshallOfSound/electron-forge/compare/v0.0.6...v0.0.7 -[0.0.6]: https://github.com/MarshallOfSound/electron-forge/compare/v0.0.5...v0.0.6 -[0.0.5]: https://github.com/MarshallOfSound/electron-forge/compare/v0.0.4...v0.0.5 -[0.0.4]: https://github.com/MarshallOfSound/electron-forge/compare/v0.0.3...v0.0.4 -[0.0.3]: https://github.com/MarshallOfSound/electron-forge/compare/v0.0.2...v0.0.3 -[0.0.2]: https://github.com/MarshallOfSound/electron-forge/compare/v0.0.1...v0.0.2 diff --git a/package.json b/package.json index fbe825c873..78dd318ce7 100644 --- a/package.json +++ b/package.json @@ -15,6 +15,9 @@ "lint": "eslint src test", "prepublish": "npm run build", "test": "npm run lint && mocha test --compilers js:babel-register --timeout=300000", + "release:patch": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version patch && git push origin && git push origin --tags", + "release:minor": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version minor && git push origin && git push origin --tags", + "release:major": "changelog -p && git add CHANGELOG.md && git commit -m 'updated CHANGELOG.md' && npm version major && git push origin && git push origin --tags", "watch": "gulp watch" }, "author": "Samuel Attard", @@ -31,6 +34,7 @@ "eslint": "^3.7.1", "eslint-config-airbnb-base": "^8.0.0", "eslint-plugin-import": "^1.16.0", + "generate-changelog": "^1.0.2", "gulp": "^3.9.1", "gulp-babel": "^6.1.2", "mocha": "^3.2.0"