Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 169 additions & 0 deletions OT-Documentation/Manual-Build/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,169 @@
<img width="1280" height="720" alt="image" src="https://github.com/user-attachments/assets/0e51fe21-83d5-4775-a390-4ebb44a1400d" />

# Manual Build Guide - Buildpiper

## Overview

This guide explains how to manually trigger builds for applications using the build pipeline interface.

## Project Info

* **Application:** APP2 (Sample)
* **Project:** ot-demo-ms (Sample)
* **Environment:** DEV-MAIN (Sample)
* **Job Template:** MI-TEMPLATE (1.0) (Sample)

---

## Prerequisites

* Access to the application portal
* Build and deploy permissions for target environment
* Application with configured builds
* Valid job template
* Already build Cluster and services
* Github Repository

---
### Step 1: Navigate to Application

<img width="1366" height="650" alt="Screenshot from 2025-10-07 10-48-05" src="https://github.com/user-attachments/assets/af79793f-4512-4eb1-b7ca-ae0a3fa07bd3" />

---

1. Click **Application** from the left sidebar
2. Click **Service Overview**
3. Select your application (e.g., **ot-demo-ms**)
4. Click on the application instance (e.g., **APP2**)
---
### Step 2: Access Build Details
1. Ensure you're on the **ENV BUILD DETAILS** tab
2. Click on environment (e.g., **DEV-MAIN**) is according to your needs whether DEV or QA
---
### Step 3: Trigger Build

<img width="1084" height="275" alt="Screenshot from 2025-10-07 10-48-17" src="https://github.com/user-attachments/assets/bf6f3cb6-959f-4b73-853a-7609516d1112" />

---



1. Click the **Build** button (right side of the page) with a Symbol ⚡
2. The **"Trigger a new Build"** dialog opens

---
### Step 4: Configure Build Settings

<img width="1359" height="653" alt="Screenshot from 2025-10-07 10-48-32" src="https://github.com/user-attachments/assets/bd6167ac-ccca-44ca-a3cf-c725c99a7083" />

---

#### Docker Cache
- **Yes** (recommended): Faster builds, uses cached layers
- **No**: Clean build, slower but ensures latest dependencies

#### Enter Tag (Optional)
- Leave blank for auto-generated tag
- Or enter custom tag (e.g., `v1.0.0`, `hotfix-123`)
- Click "Provide Custom Tag" link for help

#### Branch Name (Required)
- Select branch from dropdown
- Click "Provide Custom Branch" for custom branch entry

#### Specific Commit ID (Optional)
- Toggle **No** (default): Builds latest commit
- Toggle **Yes**: Enter specific commit SHA to build

#### Secondary Build Override (Optional)
- Toggle **No** (default): Secondary builds use same branch as main
- Toggle **Yes**: Use different branch for secondary builds

### Step 5: Review Environment
- Verify environment: **DEV** → **dev-main**
- Check **Last Builds Details** for reference

### Step 6: Execute Build
Choose one option:

- **TRIGGER BUILD**: Builds only, no deployment
- **Cancel**: Closes dialog without action

### Step 7: Monitor Build
1. Build status updates in real-time
2. Click build number to view logs
3. Check for **SUCCESS** status
---
<img width="1364" height="376" alt="image" src="https://github.com/user-attachments/assets/d36365c0-b71b-408a-ae72-b41353947854" />
---

## Action Buttons

### Top Action Bar
- **⚡ Build**: Quick Build
- **📤 Deploy**: Quick Deploy
- **🔄 Promote**: Promote build to another environment
- **☰ History**: View build/deploy history
- **<img width="30" height="28" alt="image" src="https://github.com/user-attachments/assets/919129b7-d643-4c58-aee8-47b57badbc64" />logs**: View Deployment Status

---

## Troubleshooting

| Issue | Possible Fix |
| ------------------------ | --------------------------------------------- |
| Build button not visible | Check permissions and refresh page |
| Branch dropdown empty | Verify repo connection and permissions |
| Build fails immediately | Check logs, Dockerfile, and credentials |
| Long build times | Enable Docker cache or check system resources |

---

## Best Practices

* Verify correct environment before building.
* Review last successful build for reference.
* Use consistent and meaningful tags.
* Use clean builds (cache off) for troubleshooting.
* Always check logs after triggering builds.

---

## Common Scenarios

| Scenario | Branch | Tag | Action |
| -------------------- | -------------- | ------------ | ---------------------- |
| Dev build | develop | Auto | Trigger Build |
| Release | main | v1.0.0 | Trigger Build & Deploy |
| Hotfix | hotfix/* | hotfix-issue | Trigger Build & Deploy |
| Rebuild past version | Same as before | rebuild-tag | Trigger Build |
| Feature test | feature/* | feature-test | Trigger Build & Deploy |

---

## Quick Reference

**Workflow:**

1. Application → Service Overview → Select App
2. ENV BUILD DETAILS → Verify Main Build
3. Click Build → Configure → Trigger
4. Monitor progress and logs

**Key Buttons:**

| Name | Action |
| ---------------------- | -------------------- |
| Build | Open build dialog |
| Trigger Build | Build only |
| Trigger Build & Deploy | Build and deploy |
| Refresh | Reload build history |

---

## Support

* **Build issues:** Check logs
* **Template issues:** Review job template
* **Permission issues:** Contact admin
* **Environment issues:** Check configuration