Skip to content

Commit 966f9c2

Browse files
committed
adds a screenshot
1 parent 352addb commit 966f9c2

File tree

2 files changed

+30
-5
lines changed

2 files changed

+30
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,20 @@
11
# angular-cli-ghpages
22

3+
<hr>
4+
5+
![Screenshot](screenshot-travis.png)
6+
7+
<hr>
8+
39
Angular CLI addon. Publish to any gh-pages branch on GitHub (or any other branch on any other remote).
4-
This is __NOT__ [IgorMinar/angular-cli-github-pages](https://github.com/IgorMinar/angular-cli-github-pages). Brought to you by the [angular2buch.de](https://angular2buch.de/) team!
10+
Made for Travis-CI. Brought to you by the [angular2buch.de](https://angular2buch.de/) team!
511

612
## WHY?
713

8-
[IgorMinar/angular-cli-github-pages](https://github.com/IgorMinar/angular-cli-github-pages) is limited to the `gh-pages` branch of the same repository.
14+
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.
915

1016
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).
11-
12-
__This addon works great on [Travis-CI](https://travis-ci.org/).__
17+
__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.
1318

1419
## Installation & Setup
1520

@@ -91,7 +96,27 @@ In example, the following command runs [on our Travis-CI](https://travis-ci.org/
9196
ng build --environment=production
9297
ng ghpages --repo=https://[email protected]/Angular2Buch/book-monkey2-public.git --name="The Buildbot" [email protected]
9398
```
94-
> REPO_USER_AND_PASS stores credentials in the format `username:password`. Special charcaters must be [percent-encoded](https://en.wikipedia.org/wiki/Percent-encoding).
99+
> REPO_USER_AND_PASS stores credentials in the format `username:password`. Special charcaters must be [percent-encoded](https://en.wikipedia.org/wiki/Percent-encoding).
100+
101+
### A hint for angular-cli
102+
103+
Your build can break if `angular-cli` from package.json and the global `ng` command have different versions.
104+
You might want to define a run-script like this:
105+
106+
```js
107+
"scripts": {
108+
"start": "ng server",
109+
"ng": "ng"
110+
}
111+
```
112+
113+
Now you can avoid a gloabl `ng` like this:
114+
115+
```npm run ng -- ghpages --repo=https://XXX```
116+
117+
The special extra option `--` is used to delimit the end of the command. npm will pass all the arguments after the -- directly to your script. __Happy building!__
118+
119+
95120

96121
## License
97122
Code released under the [MIT license](https://opensource.org/licenses/MIT).

screenshot-travis.png

16.4 KB
Loading

0 commit comments

Comments
 (0)