Skip to content

Commit f901a7c

Browse files
committed
docs: HOWTO rebuild labs without commmits
Signed-off-by: Jean-Luc Davern <jdavern@linuxfoundation.org>
1 parent 9346ac9 commit f901a7c

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# HOW TO Trigger a lab build to consume upstream changes
2+
3+
This guide explains how to trigger a rebuild of an existing lab environment to incorporate upstream changes without modifying the lab content.
4+
5+
## When to Use This Guide
6+
7+
Use this guide when you need to:
8+
9+
- Incorporate platform-level fixes, enhancements, or new features from the lab-building-service to an existing lab
10+
11+
## Prerequisites
12+
13+
Before you begin, ensure you:
14+
15+
- Have access to the `lftraining` GitHub Organization
16+
- Are a member of the `lab-authors` team
17+
18+
## Triggering a Lab Rebuild Using the Workflow
19+
20+
1. Open the lab repository in your browser
21+
2. Navigate to the **Actions** tab in the repository
22+
3. Locate and select the `trigger lab build` workflow
23+
4. Click **Run workflow**
24+
5. In the dropdown menu for `Use workflow from`, select the branch containing your lab environment
25+
- This is typically the branch where your lab content is defined (like `feature/implement-LFS2580004`)
26+
- If rebuilding from main, select `main`
27+
6. Fill in the workflow parameters
28+
29+
30+
### Workflow Parameters
31+
32+
- **Compute Environment Names** (required)
33+
- Enter a comma-separated list of compute environment names you want to rebuild
34+
- Example: `LFS2580004,LFS2580005`
35+
36+
!!!important "Branch Selection"
37+
The branch selection is part of GitHub's interface, not a workflow parameter, but still shows up in the same interface. Make sure to select the correct branch while entering the workflow parameters.
38+
39+
## What Happens Next
40+
41+
After triggering the workflow:
42+
43+
1. The system identifies the specified compute environments
44+
2. Each environment is sent to the lab-building-service for rebuilding
45+
3. The labs are rebuilt with the latest platform updates
46+
4. No changes are made to your lab content or configuration
47+
5. A comment on the PR is added with the new lab version and a link to staging.
48+
49+
!!!note "Build Time"
50+
Rebuilding a lab can take 20-30 minutes depending on the complexity of the environment.
51+
You can monitor progress in the Actions tab of the repository.

0 commit comments

Comments
 (0)