You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-10Lines changed: 25 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,12 +10,13 @@
10
10
Angular CLI addon. Publish to any gh-pages branch on GitHub (or any other branch on any other remote).
11
11
Made for Travis-CI. Brought to you by the [angular2buch.de](https://angular2buch.de/) team!
12
12
13
-
## WHY?
13
+
## About
14
14
15
-
This is __NOT__[IgorMinar/angular-cli-github-pages](https://github.com/IgorMinar/angular-cli-github-pages). That addon is limited to the `gh-pages` branch of the same repository.
15
+
This is similar to the normal `github-pages:deploy` command.
16
+
But by design, the command is limited to the `gh-pages` branch of the same repository.
16
17
17
18
In contrast to this, the [Angular2Buch/angular-cli-ghpages](https://github.com/Angular2Buch/angular-cli-ghpages) addon is able to push to any branch on any repository. It's build on top of [tschaub/gh-pages](https://github.com/tschaub/gh-pages).
18
-
__This addon works great on [Travis-CI](https://travis-ci.org/).__ No git credentials must be set up in before. Specific environment variables of Travis-CI are evaluated, too.
19
+
__This addon works great on [Travis-CI](https://travis-ci.org/).__ No git credentials must be set up in before. Specific environment variables of Travis-CI are evaluated, too. You will like it!
Execute `ng ghpages` in order to deploy the project with a `production` build.
38
38
39
39
Usage:
40
40
41
41
```sh
42
-
ng build
43
42
ng ghpages [OPTIONS]
44
43
```
45
44
@@ -49,14 +48,14 @@ ng ghpages [OPTIONS]
49
48
* optional
50
49
* default: url of the origin remote of the current dir (assumes a git repository)
51
50
52
-
By default, [tschaub/gh-pages](https://github.com/tschaub/gh-pages) assumes that the current working directory is a git repository, and that you want to push changes to the `origin` remote. If instead your script is not in a git repository, or if you want to push to another repository, you can provide the repository URL in the `repo` option.
51
+
By default, __gh-pages__ assumes that the current working directory is a git repository, and that you want to push changes to the `origin` remote. If instead your script is not in a git repository, or if you want to push to another repository, you can provide the repository URL in the `repo` option.
53
52
54
53
#### <aid="message">--message</a>
55
54
* optional
56
55
* default: `Auto-generated commit`
57
56
58
57
The commit message, __must be wrapped in quotes__.
59
-
Hardcoded additional text is always added, if the environment variable `process.env.TRAVIS` exists (for Travis CI).
58
+
Some handy additional text is always added, if the environment variable `process.env.TRAVIS` exists (for Travis CI).
60
59
61
60
Example:
62
61
```sh
@@ -84,15 +83,31 @@ If you are running the command in a repository without a `user.name` or `user.em
84
83
85
84
Suppress logging. With silent `true` log messages are suppressed and error messages are sanitized.
86
85
87
-
> This option should be used if the repository URL or other information passed to git commands is sensitive and should not be logged. By default the silent mode is enabled to avoid sensitive data exposure.
86
+
> This option should be used if the repository URL or other information passed to git commands is sensitive and should not be logged (== you have a public build server). By default the silent mode is enabled to avoid sensitive data exposure.
88
87
89
88
90
89
#### <aid="dir">--dir</a>
91
90
* optional
92
91
* default: `dist`
93
92
94
93
Directory for all sources, relative to the project-root.
95
-
Monst probably no change is required here.
94
+
Most probably no change is required here, usefull together with --skip-build.
95
+
This option can be used to deploy completely different folders, which are note related at all to angular.
96
+
97
+
98
+
#### <aid="environment">--environment</a>
99
+
* optional
100
+
* default: `production`
101
+
102
+
The Angular environment to create a build for.
103
+
104
+
105
+
#### <aid="skip-build">--skip-build</a>
106
+
* optional
107
+
* default: `false` (boolean)
108
+
109
+
Skip building the project before deploying, usefull together with --dir.
0 commit comments