Skip to content

Commit eef6580

Browse files
filipesilvahansl
authored andcommitted
chore: add changelog and upgrade guide (#1076)
1 parent 917c038 commit eef6580

File tree

2 files changed

+74
-2
lines changed

2 files changed

+74
-2
lines changed

CHANGELOG.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
## Always follow the [upgrade guide](https://github.com/angular/angular-cli/blob/master/CHANGELOG.md#updating-angular-cli) when upgrading to a new version. The changelog does not list breaking changes that are fixed via the update procedure.
2+
3+
<a name="1.0.0-beta.6"></a>
4+
# 1.0.0-beta.6 (2016-06-13)
5+
6+
### Features
7+
- Admin elevation no longer required on Windows (https://github.com/angular/angular-cli/pull/905).
8+
- Automatically add SASS/Stylus if project is initialized with `--style={sass|scss|styl}` (https://github.com/angular/angular-cli/pull/998).
9+
- Allow any number of env files (https://github.com/angular/angular-cli/pull/913).
10+
11+
### Bug Fixes
12+
- Fix adding 3rd party libs without package format (https://github.com/angular/angular-cli/pull/1028/commits/065e98f40384f8b28dcaf84028c411043697ff11).
13+
- Fix github deploy deep links (https://github.com/angular/angular-cli/pull/1020).
14+
- Fix `ng e2e` exit code (https://github.com/angular/angular-cli/pull/1025).
15+
- Fix missing vendor file (https://github.com/angular/angular-cli/pull/972).
16+
- Fix github user pages base href (https://github.com/angular/angular-cli/pull/965).
17+
18+
### BREAKING CHANGES
19+
- `<PROJECT-NAME>AppComponent` is now simply `AppComponent`, and it's selector is now `app-root` (https://github.com/angular/angular-cli/pull/1042).
20+
21+
- Route generation is temporarily disabled while we move to the [recently announce router](http://angularjs.blogspot.ie/2016/06/improvements-coming-for-routing-in.html)(https://github.com/angular/angular-cli/pull/992). It is recommended that users manually move to this router in all new projects.
22+
23+
<a name="1.0.0-beta.5"></a>
24+
# 1.0.0-beta.5 (2016-05-19)
25+
26+
### Known Issues
27+
28+
- `ng new -mobile` fails npm install (https://github.com/angular/angular-cli/issues/958).
29+
- Adding 3rd party libs without SystemJS package format breaks prod mode (https://github.com/angular/angular-cli/issues/951).
30+
- Deep links do not work on Github pages deploys (https://github.com/angular/angular-cli/issues/995).
31+
- `ng e2e` doesn't return error exit code on test failures (https://github.com/angular/angular-cli/issues/1017).
32+
- `ng build -prod` fails on mobile projects due to missing vendor file (https://github.com/angular/angular-cli/issues/847).
33+
- Github deploy to user pages doesn't use correct base href (https://github.com/angular/angular-cli/pull/965).
34+
- `ng test` on windows hits the file discriptor limit (https://github.com/angular/angular-cli/issues/977).
35+
- `ng serve/build/test` need admin elevation on Windows (https://github.com/angular/angular-cli/issues/641).

README.md

+39-2
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@ The generated project has dependencies that require **Node 4 or greater**.
2525
* [Installation](#installation)
2626
* [Usage](#usage)
2727
* [Generating a New Project](#generating-and-serving-an-angular2-project-via-a-development-server)
28-
* [Generating Components, Directives, Pipes and Services](#generating-other-scaffolds)
28+
* [Generating Components, Directives, Pipes and Services](#generating-components-directives-pipes-and-services)
2929
* [Generating a Route](#generating-a-route)
3030
* [Creating a Build](#creating-a-build)
31+
* [Environments](#environments)
3132
* [Running Unit Tests](#running-unit-tests)
3233
* [Running End-to-End Tests](#running-end-to-end-tests)
3334
* [Deploying the App via GitHub Pages](#deploying-the-app-via-github-pages)
@@ -36,7 +37,9 @@ The generated project has dependencies that require **Node 4 or greater**.
3637
* [Commands autocompletion](#commands-autocompletion)
3738
* [CSS preprocessor integration](#css-preprocessor-integration)
3839
* [3rd Party Library Installation](#3rd-party-library-installation)
40+
* [Updating angular-cli](#updating-angular-cli)
3941
* [Known Issues](#known-issues)
42+
* [Development Hints for hacking on angular-cli](#development-hints-for-hacking-on-angular-cli)
4043

4144
## Installation
4245

@@ -66,7 +69,7 @@ You can configure the default HTTP port and the one used by the LiveReload serve
6669
ng serve --port 4201 --live-reload-port 49153
6770
```
6871

69-
### Generating other scaffolds
72+
### Generating Components, Directives, Pipes and Services
7073

7174
You can use the `ng generate` (or just `ng g`) command to generate Angular components:
7275

@@ -90,6 +93,9 @@ Component | `ng g component my-new-component`
9093
Directive | `ng g directive my-new-directive`
9194
Pipe | `ng g pipe my-new-pipe`
9295
Service | `ng g service my-new-service`
96+
Class | `ng g class my-new-class`
97+
Interface | `ng g interface my-new-interface`
98+
Enum | `ng g enum my-new-enum`
9399

94100
### Generating a route
95101

@@ -130,6 +136,10 @@ current cli environment.
130136
Environment defaults to `dev`, but you can generate a production build via
131137
the `-prod` flag in either `ng build -prod` or `ng serve -prod`.
132138

139+
You can also add your own env files other than `dev` and `prod` by creating a
140+
`src/client/app/environment.{NAME}.ts` and use them by using the `--env=NAME`
141+
flag on the build/serve commands.
142+
133143
### Running unit tests
134144

135145
```bash
@@ -237,6 +247,33 @@ The `Angular2App`'s options argument has `sassCompiler`, `lessCompiler`, `stylus
237247

238248
The installation of 3rd party libraries are well described at our [Wiki Page](https://github.com/angular/angular-cli/wiki/3rd-party-libs)
239249

250+
### Updating angular-cli
251+
252+
To update `angular-cli` to a new version, you must update both the global package and your project's local package.
253+
254+
Global package:
255+
```
256+
npm uninstall -g angular-cli
257+
npm cache clean
258+
npm install -g angular-cli@latest
259+
```
260+
261+
Local project package:
262+
```
263+
rm -rf node_modules dist tmp
264+
npm install --save-dev angular-cli@latest
265+
ng init
266+
```
267+
268+
Running `ng init` will check for changes in all the auto-generated files created by `ng new` and allow you to update yours. You are offered four choices for each changed file: `y` (overwrite), `n` (don't overwrite), `d` (show diff between your file and the updated file) and `h` (help).
269+
270+
Carefully read the diffs for each code file, and either accept the changes or incorporate them manually after `ng init` finishes.
271+
272+
**The main cause of errors after an update is failing to incorporate these updates into your code**.
273+
274+
You can find more details about changes between versions in [CHANGELOG.md](https://github.com/angular/angular-cli/blob/master/CHANGELOG.md).
275+
276+
240277
## Known issues
241278

242279
This project is currently a prototype so there are many known issues. Just to mention a few:

0 commit comments

Comments
 (0)