Skip to content

Commit aac96a9

Browse files
committed
docs: removes advice to use @next version numbers
1 parent e29b8f1 commit aac96a9

File tree

2 files changed

+23
-28
lines changed

2 files changed

+23
-28
lines changed

README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,7 @@
3939

4040
A detailed changelog is available in the [releases](https://github.com/angular-schule/angular-cli-ghpages/releases) section.
4141

42-
In the past this project was a standalone program.
43-
This is still possible:
44-
See the documentation at [README_standalone](docs/README_standalone).
42+
4543

4644

4745

@@ -50,7 +48,8 @@ See the documentation at [README_standalone](docs/README_standalone).
5048
This command has the following prerequisites:
5149

5250
- Git 1.9 or higher (execute `git --version` to check your version)
53-
- Angular project created via [Angular CLI](https://github.com/angular/angular-cli) v8.3.0-next.0 or greater (execute `ng update @angular/[email protected] @angular/[email protected]` to upgrade your project if necessary)
51+
- Angular project created via [Angular CLI](https://github.com/angular/angular-cli) v8.3.0 or greater (execute `ng update @angular/cli @angular/core` to upgrade your project if necessary)
52+
- older Angular projects can still use the standalone program. See the documentation at [README_standalone](https://github.com/angular-schule/angular-cli-ghpages/blob/master/docs/README_standalone.md).
5453

5554

5655

@@ -59,11 +58,11 @@ This command has the following prerequisites:
5958
This quick start assumes that you are starting from scratch.
6059
If you already have an existing Angular project on GitHub, skip step 1 and 2.
6160

62-
1. Install the next version of the Angular CLI (v8.3.0-next.0 or greater) globally
61+
1. Install the latest version of the Angular CLI (v8.3.0 or greater) globally
6362
and create a new Angular project.
6463

6564
```sh
66-
npm install -g @angular/cli@next
65+
npm install -g @angular/cli
6766
ng new your-angular-project --defaults
6867
cd your-angular-project
6968
```
@@ -97,7 +96,7 @@ If you already have an existing Angular project on GitHub, skip step 1 and 2.
9796
Which is the same as:
9897

9998
```sh
100-
ng run your-angular-project:deploy
99+
ng deploy your-angular-project
101100
```
102101

103102
5. Your project should be available at `https://<username>.github.io/<repositoryname>`.
@@ -296,7 +295,9 @@ This can be very useful because it outputs what would happen without doing anyth
296295

297296
## 📁 Configuration File <a name="configuration-file"></a>
298297

299-
To avoid all these command-line cmd options, you can write down your configuration in the `angular.json` file in the `options` attribute of your deploy project's architect. Just change the kebab-case<sup id="configuration-file-mark-1">[1](#configuration-file-def-1)</sup> to lower camel case<sup id="configuration-file-mark-2">[2](#configuration-file-def-2)</sup>
298+
To avoid all these command-line cmd options, you can write down your configuration in the `angular.json` file in the `options` attribute of your deploy project's architect. Just change the kebab-case<sup id="configuration-file-mark-1">[1](#configuration-file-def-1)</sup> to lower camel case<sup id="configuration-file-mark-2">[2](#configuration-file-def-2)</sup>.
299+
300+
A list of all avaiable options is available [here](https://github.com/angular-schule/angular-cli-ghpages/blob/master/src/deploy/schema.json).
300301

301302
Example:
302303

@@ -311,15 +312,15 @@ becomes
311312
"builder": "angular-cli-ghpages:deploy",
312313
"options": {
313314
"baseHref": "https://angular-schule.github.io/angular-cli-ghpages/",
314-
"name": "angular",
315-
"email": "[email protected]"
315+
"name": "Angular Schule Team",
316+
"email": "[email protected]"
316317
}
317318
}
318319
```
319320

320-
And just run `ng deploy your-project-name` 😄.
321+
And just run `ng deploy` 😄.
321322

322-
###### You can always use the [--dry-run](#dry-run) option to verify if your configuration is right.
323+
> ℹ️ You can always use the [--dry-run](#dry-run) option to verify if your configuration is right.
323324
324325
---
325326

@@ -342,7 +343,7 @@ We look forward to any help. PRs are welcome! 😃
342343
## ⁉️ FAQ <a name="faq"></a>
343344

344345
Before posting any issue, [please read the FAQ first](https://github.com/angular-schule/angular-cli-ghpages/wiki/FAQ).
345-
See the contributors documentation at [README_contributors](docs/README_contributors) if you want to debug and test this project.
346+
See the contributors documentation at [README_contributors](https://github.com/angular-schule/angular-cli-ghpages/blob/master/docs/README_contributors.md) if you want to debug and test this project.
346347

347348

348349
## License <a name="license"></a>

docs/README_contributors.md

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,10 +25,10 @@ Follow the instructions for [checking and updating the Angular CLI version](#ang
2525
1. Install the next version of the Angular CLI.
2626

2727
```sh
28-
npm install -g @angular/cli@next
28+
npm install -g @angular/cli
2929
```
3030

31-
2. Run `ng version`, make sure you have installed Angular CLI v8.3.0-next.0 or greater.
31+
2. Run `ng version`, make sure you have installed Angular CLI v8.3.0 or greater.
3232

3333
3. Update your existing project using the command:
3434

@@ -37,19 +37,7 @@ Follow the instructions for [checking and updating the Angular CLI version](#ang
3737
```
3838

3939
Please pay attention to the version numbers of your project.
40-
`angular-cli-ghpages` was tested with Angular CLI v8.3.0-next.0 and Angular 8.2.0.
41-
Please figure out the required version numbers with:
42-
43-
```sh
44-
npm info @angular/cli@next
45-
npm info @angular/core@next
46-
```
47-
48-
Therefore, the command (at the time of writing) would be the following:
49-
50-
```sh
51-
ng update @angular/[email protected] @angular/[email protected]
52-
```
40+
`angular-cli-ghpages` was tested with Angular CLI v8.3.0 (`ng deploy` syntax) and Angular v8.2.0 (`ng run` syntax).
5341

5442
### 2. npm link
5543

@@ -109,6 +97,12 @@ Once you have completed the previous steps to `npm link` the local copy of `angu
10997

11098
4. You can now deploy your angular app to GitHub pages.
11199

100+
```sh
101+
ng deploy your-angular-project
102+
```
103+
104+
Or with the old builder syntax:
105+
112106
```sh
113107
ng run your-angular-project:deploy
114108
```

0 commit comments

Comments
 (0)