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
{{ message }}
This repository was archived by the owner on Jan 26, 2024. It is now read-only.
[](http://opensource.org/licenses/MIT)
4
5
5
6

6
7
7
8
## About
8
9
9
-
This is a sample project that helps you to implement your own __deployment builder__ (`ng deploy`) for the Angular CLI.
10
+
This is a sample project that helps you to implement your own **deployment builder** (`ng deploy`) for the Angular CLI.
10
11
The groundwork of this starter was provided by Minko Gechev's [ngx-gh project](https://github.com/mgechev/ngx-gh).
11
12
12
13
This project has the following purposes:
13
14
14
-
1. To promote the adoption of `ng deploy`.
15
-
2. To clarify various questions and to standardise the experience of the various builders.
15
+
**Goal 1:** To promote the adoption of `ng deploy` by providing a blueprint for new builders.
16
+
**Goal 2:** To clarify various questions and to standardise the experience of the existing builders.
16
17
17
18
We hope for an inspiring discussion, pull requests and questions.
18
19
19
20
**If you don't know `ng deploy` yet, learn more about this command here:
20
-
[👉 Blogpost: All you need to know about `ng deploy`](https://angular.schule/blog/2019-08-ng-deploy)**
21
-
22
-
## Essential considerations
23
-
24
-
There are still differences between the existing builders.
25
-
Let's find some rules that everyone agrees with. Here are two proposals.
26
-
27
-
### 1. A deployment builder must always compile the project before the deployment
28
-
29
-
To reduce the chances to deploy corrupted assets, it's important to build the app right before deploying it. ([source](https://github.com/angular-schule/website-articles/pull/3#discussion_r315802100))
30
-
31
-
**Current state:**
32
-
Currently there are existing deployment builders that only build in production mode.
33
-
This might be not enough.
34
-
There is also the approach not to perform the build step at all.
35
-
36
-
**Our suggestion:**
37
-
By default, a deployment builder **shall** compile in `production` mode, but it **should** be possible to override the default configuration using the option `--configuration`.
We appreciate your [feedback](https://github.com/angular-schule/ngx-deploy-starter/issues)!
55
-
56
-
57
-
## How to make your own deploy builder
25
+
We are there to assist you in creating a builder.
58
26
59
27
1. fork this repository
60
28
2. adjust the `package.json`
@@ -63,22 +31,23 @@ We appreciate your [feedback](https://github.com/angular-schule/ngx-deploy-start
63
31
5. add your deployment code to `src/engine/engine.ts`, take care of the tests
64
32
6. follow the instructions from the [contributors README](docs/README_contributors.md) for build, test and publishing.
65
33
66
-
67
34
You are free to customise this project according to your needs.
68
35
Please keep the spirit of Open Source alive and use the MIT or a compatible license.
69
36
37
+
## Goal 2: Best practices for deployment builders
70
38
71
-
## Projects based on ngx-deploy-starter
72
-
73
-
*[ngx-deploy-npm](https://github.com/bikecoders/ngx-deploy-npm) – Deploy your Angular Package to NPM directly from the Angular CLI! 🚀
74
-
*[angular-cli-ghpages](https://github.com/angular-schule/angular-cli-ghpages) – Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀
75
-
39
+
This project also aims to be a reference for the existing builders.
40
+
Recommendations are made through RFCs (Request for Comments), and we are very pleased about their adoption.
41
+
[Here is a list of all existing RFCs](https://github.com/angular-schule/ngx-deploy-starter/issues?q=is%3Aissue+%5BRFC%5D).
76
42
43
+
## Projects based on ngx-deploy-starter
77
44
45
+
-[ngx-deploy-npm](https://github.com/bikecoders/ngx-deploy-npm) – Deploy your Angular Package to NPM directly from the Angular CLI! 🚀
46
+
-[angular-cli-ghpages](https://github.com/angular-schule/angular-cli-ghpages) – Deploy your Angular app to GitHub pages directly from the Angular CLI! 🚀
0 commit comments