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
+13-12Lines changed: 13 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,28 +2,29 @@
2
2
3
3
## Overview
4
4
5
-
This project automates the building of custom Firecracker. It supports building specific firecracker versions and uploading the resulting binaries to a Google Cloud Storage (GCS) bucket.
5
+
This project automates the building of custom Firecracker versions. It supports building specific firecracker versions and uploading the resulting binaries to a Google Cloud Storage (GCS) bucket.
6
6
7
7
## Prerequisites
8
8
9
9
- Linux environment (for building firecracker)
10
10
11
11
## Building Firecrackers
12
12
13
-
1.**Configure firecracker versions:**
14
-
- Edit `firecracker_versions.txt` to specify which firecracker versions to build (one per line, e.g., `<last_tag-prelease>-<first-8-letters-of-the-specific-commit>`).
13
+
The `firecracker_versions.txt` file specifies which versions to build:
15
14
16
-
2.**Build:**
15
+
- Edit `firecracker_versions.txt` to specify firecracker versions (one per line)
16
+
- Versions can be tags (e.g., `v1.10.1`) or tag with shorthash (e.g., `v1.12.1_abcdef12`)
17
+
- On every push, GitHub Actions will automatically:
18
+
1. Parse versions from `firecracker_versions.txt` and resolve commit hashes
19
+
2. Build each version in parallel
20
+
3. Check CI status for each version
21
+
4. Upload successful builds to GCS and create GitHub releases (on main branch)
17
22
18
-
```sh
19
-
make build
20
-
```
23
+
## Scripts
21
24
22
-
The built firecrackers will be placed in `builds/<version_name>/firecracker`.
23
-
24
-
## Development Workflow
25
-
26
-
- On every push, GitHub Actions will automatically build the firecrackers and save it as an artifact.
25
+
-`build.sh <version> <hash> <version_name>` - Builds a single Firecracker version
26
+
-`scripts/parse-versions-with-hash.sh` - Parses versions and resolves commit hashes
27
+
-`scripts/check-fc-ci.sh <versions_json>` - Checks CI status for parsed versions
0 commit comments