ItzYanick/vanilla-os-image
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

wip: add initial docs

Browse source 
Signed-off-by: K.B.Dharun Krishna <kbdharunkrishna@gmail.com>
This commit is contained in:
K.B.Dharun Krishna 2024-02-02 13:00:31 +05:30
parent bdbdcb74ab
commit 3b200ad4f9
No known key found for this signature in database
GPG key ID: 1B8ECA406788AFA4
2 changed files with 17 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/vib-build.yml vendored
View file

@ -97,7 +97,7 @@ jobs:
recipe: 'recipe.yml'
plugins: 'Vanilla-OS/vib-fsguard:v1.2-1'
- name: generate image name
- name: Generate image name
run: |
REPO_OWNER_LOWERCASE="$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]')"
echo "REPO_OWNER_LOWERCASE=$REPO_OWNER_LOWERCASE">> "$GITHUB_ENV"

17
README.md
View file

@ -1,3 +1,18 @@
# Custom Vib Image
This template repository is a starting point for creating custom Vib images.
This template repository is a starting point for creating custom [Vib images](https://github.com/Vanilla-OS/Vib) on top of our desktop image. It contains a basic recipe and an example module to get you started.
It is suggested to checkout the [Vib repository's README](https://github.com/Vanilla-OS/Vib?tab=readme-ov-file#recipe-format) to know more about the recipe format, structure of modules and the supported fields.
## Explore
Now, that you are aware of the basic syntax, 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 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. 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 view the artifact to verify that your changes are performed as expected.
- `.github/dependabot.yml`: This file contains the configuration for 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 (It also contains ABRoot's configuration file).
- `modules`: This directory contains the modules that are used to customize the image. You can add your own modules to this directory.
- `recipe.yml`: This file contains the recipe for the image. It contains the base image, modules and other fields to be present in the image.
## Getting Started