Skip to content

Commit 3742a9c

Browse files
committed
Add netlify site deploy doc
Signed-off-by: Prajyot-Parab <prajyot.parab2@ibm.com>
1 parent 0ef02ce commit 3742a9c

File tree

2 files changed

+97
-0
lines changed

2 files changed

+97
-0
lines changed

docs/book/src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
- [How to build the machine boot images](./developer/build-images.md)
3232
- [Modules and tools dependencies](./developer/dependencies.md)
3333
- [E2E testing](./developer/e2e.md)
34+
- [Deploy latest netlify site](./developer/netlify-site.md)
3435
- [Troubleshooting](./user/troubleshooting.md)
3536
- [Reference](./reference/reference.md)
3637
- [API References](./reference/api-references.md)
Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Step-by-Step Guide: Deploy Latest Branch on Netlify
2+
3+
## Step 1: Log in to Netlify
4+
Log in to Netlify at:
5+
https://app.netlify.com/
6+
7+
Use the **GitHub SSO** method to sign in.
8+
After logging in, navigate to the project dashboard at:
9+
https://app.netlify.com/sites/kubernetes-sigs-cluster-api-ibmcloud
10+
11+
If you do not have access to this Netlify project, you will need to **request membership**.
12+
Raise a Netlify project membership request similar to the following example:
13+
https://github.com/kubernetes/org/issues/5284
14+
15+
> **Note:**
16+
> - As of today, **only [@Prajyot-Parab](https://github.com/Prajyot-Parab)** has direct access to this specific Netlify project.
17+
> - Members of the **Kubernetes Docs Team** in Netlify have access to **all Netlify projects under the Kubernetes organization**.
18+
19+
---
20+
21+
## Step 2: Open Your Project
22+
From the Netlify dashboard, select the project (site) you want to deploy.
23+
24+
---
25+
26+
## Step 3: Go to Project Configuration
27+
In your project dashboard, navigate to **Project configuration** (or **Site settings**).
28+
29+
---
30+
31+
## Step 4: Open Build & Deploy Settings
32+
From the left-hand menu, click **Build & deploy**.
33+
34+
---
35+
36+
## Step 5: Configure Deploy Contexts
37+
Scroll to the **Deploy contexts** section.
38+
39+
Add the **new release branch** to the list of branches that should trigger deployments.
40+
41+
---
42+
43+
## Step 6: Create a Pull Request to the Release Branch
44+
In your Git repository (GitHub / GitLab / Bitbucket):
45+
46+
- Create a pull request targeting the **release branch**
47+
- Ensure all checks pass
48+
- Merge the pull request into the release branch
49+
50+
---
51+
52+
## Step 7: Trigger Netlify Branch Deployment
53+
Once the pull request is merged, Netlify will automatically trigger a deploy for the **release branch** with the latest changes.
54+
55+
---
56+
57+
## Step 8: Verify Deployment in Netlify
58+
In Netlify, navigate to the **Deploys** section of your project.
59+
60+
You can:
61+
- **Review the branch deploy status and logs for the latest release version**
62+
- Preview the deployed site
63+
- Click **Retry deploy → Deploy with latest commit** if needed
64+
65+
---
66+
67+
## Step 9: Disable Branch Deploys for Custom Domains
68+
In **Site settings → Domain management**, configure automatic deploy subdomains:
69+
70+
1. Go to **Automatic deploy subdomains**
71+
2. Click **Edit custom domains**
72+
3. **Uncheck “Branch deploys”**
73+
4. Click **Save**
74+
75+
This ensures branch deploys do not automatically attach to your custom domain.
76+
77+
---
78+
79+
## Step 10: Configure Branch Subdomains
80+
Still in **Site settings**, configure branch subdomains:
81+
82+
1. Go to **Domain management**
83+
2. Navigate to **Branch subdomains**
84+
3. Click **Add new branch subdomain**
85+
4. Select or enter the **new release branch**
86+
5. Click **Create branch subdomain**
87+
88+
---
89+
90+
## Step 11: Enable Branch Deploys for Custom Domains
91+
In **Site settings → Domain management**, configure automatic deploy subdomains:
92+
93+
1. Go to **Automatic deploy subdomains**
94+
2. Click **Edit custom domains**
95+
3. **Check “Branch deploys”**
96+
4. Click **Save**

0 commit comments

Comments
 (0)