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
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -121,9 +121,15 @@ ng deploy --repo=https://github.com/<username>/<repositoryname>.git --name="Your
121
121
122
122
(replace `<username>` and `<repositoryname>` with your username from GitHub and the name of your repository)
123
123
124
+
> **⚠️Important**
125
+
>
124
126
> Please **do not disable the silent mode** if you use tokens, otherwise people could read them in the output logs.
125
127
> If you are sure that your CI/CD provider does not display secrets on the console (this applies to CircleCI / Travis CI and Github Actions), you are welcome to disable silent mode.
126
128
129
+
> **ℹ️ Note for GitHub Actions**
130
+
>
131
+
> The `GITHUB_TOKEN` (installation access token) will only trigger a release of a new website if the action runs in a private repository. In a public repo, a commit is generated, but the site does not change. See this [GitHub Community post](https://github.community/t5/GitHub-Actions/Github-action-not-triggering-gh-pages-upon-push/m-p/26869) for more info. If your repo is public, you must still use the `GH_TOKEN` (personal access token).
132
+
127
133
## 📦 Options <aname="options"></a>
128
134
129
135
#### --base-href <aname="base-href"></a>
@@ -199,7 +205,9 @@ and that you want to push changes to the `origin` remote.
199
205
If instead your files are not in a git repository, or if you want to push to another repository,
200
206
you can provide the repository URL in the `repo` option.
201
207
202
-
> **ℹ️ Hint:** Set an environment variable with the name `GH_TOKEN` / `PERSONAL_TOKEN` or `GITHUB_TOKEN` and it will be automatically added to the URL, if it uses the HTTPS shema (it must start with `https://github.com`).
208
+
> **ℹ️ Hint**
209
+
>
210
+
> Set an environment variable with the name `GH_TOKEN` / `PERSONAL_TOKEN` or `GITHUB_TOKEN` and it will be automatically added to the URL, if it uses the HTTPS shema (it must start with `https://github.com`).
203
211
> Tokens are generally not supported for Git over SSH (starts with `[email protected]`).
204
212
205
213
Learn more about ["personal access tokens" here](https://help.github.com/articles/creating-an-access-token-for-command-line-use/) (`GH_TOKEN`) and about the ["installation access token" here](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token) (`GITHUB_TOKEN`). `PERSONAL_TOKEN` is an alias for `GH_TOKEN`.
@@ -250,7 +258,9 @@ In silent mode, the error messages for git operations are always sanitized.
250
258
The `--no-silent` option enables detailed error messages and extended console logging.
251
259
Keep this untouched if the repository URL or other information passed to git commands is sensitive!
252
260
253
-
> **⚠️ WARNING:** This option should be kept as it is if the repository URL or other information passed to Git commands is sensitive and should not be logged (== you have a public build server and you are using the token feature).
261
+
> **⚠️ WARNING**
262
+
>
263
+
> This option should be kept as it is if the repository URL or other information passed to Git commands is sensitive and should not be logged (== you have a public build server and you are using the token feature).
254
264
> By default the silent mode is enabled to avoid sensitive data exposure.
255
265
256
266
#### --no-dotfiles <aname="no-dotfiles"></a>
@@ -332,7 +342,9 @@ becomes
332
342
333
343
And just run `ng deploy` 😄.
334
344
335
-
> **ℹ️ Hint:** You can always use the [--dry-run](#dry-run) option to verify if your configuration is right.
345
+
> **ℹ️ Hint**
346
+
>
347
+
> You can always use the [--dry-run](#dry-run) option to verify if your configuration is right.
336
348
337
349
## 🌍 Environments <aname="environments"></a>
338
350
@@ -358,7 +370,7 @@ Code released under the [MIT license](LICENSE).
0 commit comments