Skip to content

Commit 61b4dd7

Browse files
committed
Update README With information on how to use the repository
Update the README providing information on how to request the building of older and newer versions of the monitors. Signed-off-by: Charalampos Mainas <charalampos.mainas@gmail.com>
1 parent c79b843 commit 61b4dd7

1 file changed

Lines changed: 33 additions & 5 deletions

File tree

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,40 @@ The following components are currently supported:
1313
- [**Solo5**](https://github.com/Solo5/solo5)
1414
- [**virtiofsd**](https://gitlab.com/virtio-fs/virtiofsd)
1515

16-
## Artifact Packaging
16+
## How to use
1717

18-
Each component is built using the version specified in the `VERSION` file
19-
located in its respective directory. The resulting binaries are packaged into a
20-
single tar archive, which can be downloaded from the repository’s **Releases**
21-
page.
18+
This repository serves as a hub for storing various builds of `urunc`'s
19+
supported monitors and provides an easy platform for building both newer and
20+
older versions of them.
21+
22+
Every user can request the build of any monitor version by opening a new Pull Request
23+
(PR). The process is the following one:
24+
25+
1. **Specify the monitor version to build**: The version of each monitor is
26+
specified in the `VERSION` file located in its respective directory (e.g.,
27+
for Solo5, the version is in [solo5/VERSION](solo5/VERSION)).
28+
2. **Open a new PR**: Create new PR with the version change.
29+
3. **PR workflow gets triggered**: Upon opening a new PR a workflow will check
30+
whether a) the requested versions of monitors have been built before and if
31+
these artifacts are still valid and b) a previous release includes these
32+
monitors. If a monitor with the specified version does not exist, then the
33+
workflow will build it. The workflow will comment in the PR with the findings.
34+
4. **Merge of PR and creation of new relase**: Upon the approval and merge of
35+
the PR in the main branch, a new workflow will collect all the artifacts of
36+
the monitors and create a new release following the [release naming
37+
scheme](#Release-Naming-Scheme).
38+
39+
__Note for QEMU__
40+
41+
Since QEMU is highly configurable, the build process also tracks changes in the
42+
following configuration files:
43+
44+
- [amd64.config](qemu/amd64.config): Configuration for building Qemu on amd64
45+
architectures,
46+
- [arm64.config](qemu/arm64.config): Configuration for building Qemu on arm64
47+
architectures.
48+
- [excluded files list](qemu/unnecessary_files.txt): the list with the excluded
49+
files from the final Qemu installation directory.
2250

2351
## Release Naming Scheme
2452

0 commit comments

Comments
 (0)