7c27657c79
This was discussed in slack, where a user was missing the Git commit ID in his
custom build
Reason is/was:
git clone --single-branch -b 1.4.0-epa1 https://github.com/vyos/vyos-build
Checks out the 1.4.0-epa1 tag as HEAD and does not clone any branch information.
This results in:
>>> import git
>>> repo = git.Repo('.')
>>> repo.head.object.hexsha[:14]
'bcac2eb1f9b49c'
>>> git_branch = repo.active_branch.name
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/usr/lib/python3/dist-packages/git/repo/base.py", line 881, in active_branch
return self.head.reference
^^^^^^^^^^^^^^^^^^^
File "/usr/lib/python3/dist-packages/git/refs/symbolic.py", line 311, in _get_reference
raise TypeError("%s is a detached symbolic reference as it points to %r" % (self, sha))
TypeError: HEAD is a detached symbolic reference as it points to 'bcac2eb1f9b49cc15ebda65838e5465543dbb9c6'
during the build. The exception handler resets the branch and commit name to an empty string: a3e60a00b4/scripts/build-vyos-image (L281-L296)
This now adds a proper error message during build so it fails early.
(07:46) vyos_bld 08278c5a1172:/vyos/vyos-build # isobuild -test
Building custom VyOS version: 1.5-test-202402250746
I: Checking if packages required for VyOS image build are installed
build/config
Could not retrieve information from git: HEAD is a detached symbolic reference as it points to '39612f541e55bea19868f50f16d7a6c6e0034ed2'
VyOS toplevel build
For the most up-to-date documentation, please read the online build guide at docs.vyos.io.
What is VyOS
VyOS is an open source operating system for network devices (routers, firewalls and so on). If you want to use it in your network, check out download and installation instructions at https://docs.vyos.io/en/latest/installation/index.html
If you want to modify VyOS and/or join its development, read on.
About this repository
VyOS is a GNU/Linux distribution based on Debian. Just like any other distribution, it consists of multiple packages.
Some packages are taken from the upstream, while other are modified or written from scratch by VyOS developers. Every package maintained by the VyOS team has its own git repository. VyOS image build is therefore a multi-step process. Packages are compiled first, then an ISO is built from Debian packages and our own packages.
This is the top level repository that contains links to repositories with VyOS specific packages (organized as Git submodules) and scripts and data that are used for building those packages and the installation image.
Repository Structure
There are several directories with their own purpose:
build/Used for temporary files used for the build and for build artifactsdata/Data required for building the ISO (e.g. boot splash/configs)packages/This directory has two meanings. First it can hold arbitrary *.deb packages which will be embeded into the resulting ISO, but it also holds Jenkins Pipeline definitions for required VyOS packages. Among other things those packages will be: Linux Kernel, FRR, Netfiler...scripts/Scripts that are used for the build processtools/Scripts that are used for maintainer's tasks automation and other purposes, but not during ISO build processvars/Jenkins Pipeline library for reusable functions
Building VyOS
In order to have a single manual and not maintining multiple copies the instructions on how to build VyOS either in a Docker container or natively can be found in our Documentation - Build VyOS.
Development Branches
The default branch that contains the most recent VyOS code is called current.
We may or may not eventually switch to main.
All new code goes to the current branch. When a new LTS release is ready for feature freeze, a
new branch is created for the release, and new code from current is backported
to the release branch as needed.
Post-1.2.0 branches are named after constellations sorted by area from smallest to largest. There are 88 of them, here's the complete list.
Existing branches:
- VyOS 1.4:
sagitta(Arrow) [LTS] - VyOS 1.3:
equuleus(Little Horse) [LTS] - VyOS 1.2:
crux(Southern Cross) [Unsupported]
The next LTS release will be VyOS 1.5 circinus (Compasses).