bookdown-guide/0032-deploy.Rmd at main · cbw-dev/bookdown-guide · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# Deploy your site {#deploy-website}

1.  In the top navigation bar, select **Settings**.

    ::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}
    ![Base repo, pointing at settings](img/git-instruct/github-settings.png)
    :::

2.  Then, go to the **Pages** sidebar option.

    ::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}
    ![Selecting pages from the settings page](img/git-instruct/github-select-pages.png)
    :::

3.  "Deploy from a branch" is already selected, which is what we want. We must **change the branch from "none" to "main"**. Select the "None" dropdown button and select "main".

    ::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}
    ![Select main as the branch](img/git-instruct/github-deploy-main.png)\
    :::

4.  Change the folder from `/root` to `/docs` and press **save**.

    ::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}
    ![Select /docs as the branch](img/git-instruct/github-deploy-docs.png)\
    :::

Great! Now we're waiting on the page to build and deploy, which should take less than a minute.

## Check your deploy and see your website! {#check-deploy}


To see updates, go to the **Actions** page (found along the top navigation bar. This will help you understand how the deploy is working, and if it succeeded or failed.

::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}

![Image showing the different possibilities of deploy a github page](img/git-instruct/github-pages-actions-explained.png)\

:::

You can click <u>**pages build and deployment**</u> for updates.


::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}

![where to click for pages build and deployment information](img/git-instruct/pages-build-and-deployment.png)\

:::

A **successful deploy** will have a green checkmark next to it. You can inspect the 3 steps: build, report-build-status, deploy. Once it's done deploying, **you can find the website at the link provided under the "deploy" step**!

::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}

![successful deploy](img/git-instruct/successful-deploy.png)\

:::

A **failed deploy** will have a red cross next to it. Clicking through the steps can help you determine what went wrong in the deploy.

::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}

![failed deploy](img/git-instruct/failed-deploy.png)\

:::

::: {.callout type="orange" title="Important!" style="subtle" icon="true"}

Warning: A website can build properly, but may not deploy properly! It is a good idea to check after making big changes.

:::

## A very specific build and deployment warning {-}

This is a very specific (and unlikely) warning. It occurs when 1 deploy hasn't finished, but another deploy began. This is a warning message you do not have to worry about!

::: {.callout type="gray" title="See image" collapsible="true" style="plain" icon="fa-solid fa-image"}

![two consecutive deploy warnings](img/git-instruct/exclamation-point-deploy-warning.png)\

:::