From 21acd8671517cd1804ee2070323ee7c1c01a2fc7 Mon Sep 17 00:00:00 2001 From: Sebastien Dubois Date: Thu, 29 Mar 2018 10:32:20 +0200 Subject: [PATCH] feat(build): added changelog generation. Closes #24 --- CHANGELOG.md | 29 +++++++++++++++++++++++++++++ README.md | 3 +++ RELEASE.md | 11 +++++++++++ package.json | 4 +++- 4 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 CHANGELOG.md create mode 100644 RELEASE.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000000..e7e0eb3f74 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,29 @@ + +# 10.0.0-alpha.1 (2018-03-29) + + +### Bug Fixes + +* **build:** fixed issue with prettier config name with webpack plugin and added new scripts at root ([51be4f6](https://github.com/nationalbankbelgium/stark/commit/51be4f6)) +* **http:** fix unit tests. Enhance http demo in Starter ([#268](https://github.com/nationalbankbelgium/stark/issues/268)) ([6d609b8](https://github.com/nationalbankbelgium/stark/commit/6d609b8)), closes [#68](https://github.com/nationalbankbelgium/stark/issues/68) [#68](https://github.com/nationalbankbelgium/stark/issues/68) [#84](https://github.com/nationalbankbelgium/stark/issues/84) [#93](https://github.com/nationalbankbelgium/stark/issues/93) [angular/zone.js#1015](https://github.com/angular/zone.js/issues/1015) [#96](https://github.com/nationalbankbelgium/stark/issues/96) +* **lazy-loading:** Remove PreloadAllModules preloading strategy from routing coneiguration to make lazy-loaded modules to be actually lazy loaded :) ([9634dac](https://github.com/nationalbankbelgium/stark/commit/9634dac)) +* **lazy-loading:** Remove PreloadAllModules preloading strategy from routing coneiguration tz makz lazz-loaded modules to be actually lazy loaded :) ([80d09ce](https://github.com/nationalbankbelgium/stark/commit/80d09ce)) +* **linting:** clean stark-build/tslint.json. Remove obsolete options for 'ban' rule ([86ed26c](https://github.com/nationalbankbelgium/stark/commit/86ed26c)) +* **linting:** fix some TS linting issues ([8d5d6a8](https://github.com/nationalbankbelgium/stark/commit/8d5d6a8)) + + +### Features + +* **build:** added .gitattributes. Closes [#144](https://github.com/nationalbankbelgium/stark/issues/144). ([b4c3ef2](https://github.com/nationalbankbelgium/stark/commit/b4c3ef2)) +* **build:** added support for building a subset of the packages ([55ec4c1](https://github.com/nationalbankbelgium/stark/commit/55ec4c1)) +* **http:** create StarkHttp module. Fixed imports. Implemented small demo in Starter [[#96](https://github.com/nationalbankbelgium/stark/issues/96)] ([201edb8](https://github.com/nationalbankbelgium/stark/commit/201edb8)) +* **http:** implement Stark Http in stark-core (unit tests to be completed) [[#96](https://github.com/nationalbankbelgium/stark/issues/96)] ([579c59b](https://github.com/nationalbankbelgium/stark/commit/579c59b)) +* **http:** implement Stark Http in stark-core (unit tests to be completed) [[#96](https://github.com/nationalbankbelgium/stark/issues/96)] ([719d92d](https://github.com/nationalbankbelgium/stark/commit/719d92d)) +* **polyfills:** Update polyfills.browser.ts with the relevant polyfills needed only for IE11 and some special features from Angular. Add needed npm dependencies for those polyfils ([2b6a160](https://github.com/nationalbankbelgium/stark/commit/2b6a160)) +* **routing:** adapt CSP style-src directive to allow inline styles from UI Router visualizer ([8a1a8fa](https://github.com/nationalbankbelgium/stark/commit/8a1a8fa)) +* **routing:** add UI Router visualizer. Adapt CSP img-src directive to allow png images from UI Router visualizer ([3bc995b](https://github.com/nationalbankbelgium/stark/commit/3bc995b)) +* **routing:** replace Angular Router by UI Router ([24b70d4](https://github.com/nationalbankbelgium/stark/commit/24b70d4)) +* **stark-testing:** create separate stark-testing package and use it in all stark packages and starter ([#267](https://github.com/nationalbankbelgium/stark/issues/267)) ([204dc35](https://github.com/nationalbankbelgium/stark/commit/204dc35)), closes [#68](https://github.com/nationalbankbelgium/stark/issues/68) [#68](https://github.com/nationalbankbelgium/stark/issues/68) [#84](https://github.com/nationalbankbelgium/stark/issues/84) [#93](https://github.com/nationalbankbelgium/stark/issues/93) [angular/zone.js#1015](https://github.com/angular/zone.js/issues/1015) + + + diff --git a/README.md b/README.md index 0ff63f8d93..eba7cf4b06 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,9 @@ TODO add links to developer guide sections ### Contributing Please follow our [contribution guidelines](/CONTRIBUTING.md) +### Releaseing Stark +See [this page](/RELEASE.md) + ## Authors ### Sebastien Dubois diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000000..960e9f6612 --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,11 @@ +# Releasing Stark + +## Changelog +First of all: *Never* edit CHANGELOG.md manually! + +To update the changelog, execute: `npm run update:changelog`. +That script uses conventional-changelog (https://github.com/conventional-changelog) through the CLI (https://www.npmjs.com/package/conventional-changelog-cli). +We use the Angular format for our changelog and for it to work properly, please make sure to respect our commit conventions (see CONTRIBUTING guide) + +## Publishing a new release +... \ No newline at end of file diff --git a/package.json b/package.json index 81937b6f72..1de8b56508 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "stark-srcs", - "version": "10.0.0-alpha.0", + "version": "10.0.0-alpha.1", "private": true, "description": "Stark - a framework for Angular apps", "author": "Stark Team ", @@ -23,6 +23,7 @@ "@angular/compiler": "5.2.10", "@angular/compiler-cli": "5.2.10", "codelyzer": "4.3.0", + "conventional-changelog-cli": "1.3.21", "husky": "0.14.3", "lint-staged": "7.0.4", "prettier": "1.12.1", @@ -48,6 +49,7 @@ "build:stark-build": "npm run build -- --packages=stark-build", "build:stark-core": "npm run build -- --packages=stark-core", "build:stark-testing": "npm run build -- --packages=stark-testing", + "update:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0 && git add CHANGELOG.md", "preupdate:starter": "npm run clean:starter", "update:starter": "cd starter && npm install && cd ..", "starter": "cd starter && npm start && cd ..",