diff mbox series

[yocto-autobuilder2] README-Guide: Add yocto_console_view build directions.

Message ID CADfgfobJCbbvjGO69kHKWu0NJtHqY11Fzx_jarXVXbbR7ezcmw@mail.gmail.com
State New
Headers show
Series [yocto-autobuilder2] README-Guide: Add yocto_console_view build directions. | expand

Commit Message

Michael Halstead Dec. 11, 2025, 6:35 p.m. UTC
Adding directions we use to build for production.

Signed-off-by: Michael Halstead <mhalstead@linuxfoundation.org>
---
 README-Guide.md | 72 +++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)

+
+    # IMPORTANT: Check that the cluster is idle before restarting at
+    # Restart the controller instance
+    buildbot restart ~/yocto-controller
+    ```
+
+The new console view plugin is now deployed and active.
+
+
 ### 1.3) Customizing the Autobuilder Configuration

 Next, we need to update the `yocto-controller/yoctoabb/master.cfg` towards the
--
2.43.0
Michael Halstead
Linux Foundation / Yocto Project
Systems Operations Engineer
diff mbox series

Patch

diff --git a/README-Guide.md b/README-Guide.md
index 69368b9..bee5a1f 100644
--- a/README-Guide.md
+++ b/README-Guide.md
@@ -72,6 +72,78 @@  being triggered:
 export LANG=en_US.UTF-8
 ```

+### 1.2.1) Building and Deploying the Yocto Console View
+
+
+Build the Package on a Workstation
+
+These steps are performed on your local development machine.
+
+**Prerequisites:** You must have **Podman** installed.
+
+1.  Clone the `yocto-autobuilder2` repository and start a container,
mounting the repository into the `/build` directory.
+
+    ```bash
+    git clone https://git.yoctoproject.org/yocto-autobuilder2
+    cd yocto-autobuilder2/
+    podman run -ti --rm --volume .:/build:Z,U node:22 bash
+    ```
+
+2.  **Inside the container**, navigate to the package directory,
install the necessary build dependencies, and build the Python wheel
(`.whl`) file.
+
+    ```bash
+    # Run these commands inside the podman container
+    cd /build/yocto_console_view
+    apt update; apt install -y python3-dev python3-build
python3-setuptools python3-pip
+    python3 -m pip install --break-system-packages buildbot_pkg
+    python3 -m build --no-isolation
+    ```
+
+3.  A successful build will generate a wheel file in the `dist/`
directory. You can verify this by listing the contents of the `dist/`
directory.
+
+    ```bash
+    ls dist/
+    ```
+
+    You should see a file named like
`yocto_console_view-2025.3.12-py3-none-any.whl`.
+
+4.  Once the build is complete, exit the container.
+
+    ```bash
+    # Press Ctrl+D or type 'exit'
+    exit
+    ```
+
+-----
+
+Deploy the Package to the Controller
+
+These steps are performed on the Buildbot controller machine.
+
+1.  First, copy the newly created wheel file from your workstation to
the controller. The file will be located in the
`yocto-autobuilder2/yocto_console_view/dist/` directory on your
workstation.
+
+    *Example filename:* `yocto_console_view-2025.3.12-py3-none-any.whl`
+
+2.  On the **controller**, switch to the `pokybuild` user, activate
the buildbot virtual environment, install the new wheel, and restart
the controller.
+
+    ```bash
+    # Switch to the build user
+    su - pokybuild
+
+    # Activate the Python virtual environment, if not already active
+    . ~/buildbot-venv/bin/activate
+
+    # Install the package you copied over
+    pip install yocto_console_view-2025.3.12-py3-none-any.whl