From 6dae5e4d072c655ae7508ae507ae18ee844115bc Mon Sep 17 00:00:00 2001 From: "K.B.Dharun Krishna" Date: Sat, 11 May 2024 15:20:15 +0530 Subject: [PATCH] docs: improve explore section Signed-off-by: K.B.Dharun Krishna --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 05c894e..ccba49c 100644 --- a/README.md +++ b/README.md @@ -31,11 +31,9 @@ If your image is successfully built, you can then point ABRoot to your custom im Now, that you are aware of the basics, let's explore the files and directories present in this repository: -- `.github/workflows/vib-build.yml`: This file contains the GitHub Actions workflow to check for updates to the base image and build the Vib image. - - It uses the `vib` action to build the recipe and upload it as an artifact. The generated artifact is then built using Docker and pushed to GHCR. +- `.github/workflows/vib-build.yml`: This file contains the GitHub Actions workflow to check for updates to the base image and build the Vib image on push and on pull requests. + - It uses the [`vib-gh-action`](https://github.com/Vanilla-OS/vib-gh-action) to build the recipe and upload it as an artifact. The generated artifact is then built using Docker's actions and pushed to GHCR (**Note**: The image with the respective branch tags is published to GHCR only on push actions to the branches in your repository or on tags and not on pull requests). - The action runs automatically on a schedule checking updates to the base image using [Differ](https://github.com/Vanilla-OS/Differ). -- `.github/workflows/vib-pr.yml`: This file contains the GitHub Actions workflow to build the Vib image on pull requests. - - It uses the `vib` action to build the recipe and upload it as an artifact. You can download and view the artifact to verify that your changes are performed as expected. - `.github/dependabot.yml`: This file contains the configuration for GitHub's Dependabot to check for updates to the GitHub actions used in the workflow files monthly and when it finds a new version it creates a PR in your repository. - `includes.container`: The files included in this directory are added by default to your image to the specified location. (It also contains ABRoot's configuration file) - `modules`: This directory contains the modules that are used to customize the image. You can add your modules to this directory.