-
Notifications
You must be signed in to change notification settings - Fork 3
Create Release
This is a basic guide for building the kernel, compressing the image as a versioned release and creating a new release on GitHub.
In order to create a released kernel image, you have to be able to build the kernel following the previous Installation guide.
You can use the Makefile
in order to compress the kernel image and produce the .tar.gz
and .zip
compressed images. The procedure is the same for either Raspberry Pi Zero and Raspberry Pi 4. But in the later case, we have to also compress the armstub
in order for the Pi to boot properly.
After new kernel release, we can change the version of the kernel that is saved in the Makefile
. Just change the following variable for creating a new version:
KERNEL_VERSION = 0.1.0
The project follows the Semantic Versioning guide for the version naming scheme.
In order to build and compress for the Raspberry Pi Zero or Zero W, compile with the following flag:
make RASPI_MODEL=0 release
It will produce the following for KERNEL_VERSION = 0.1.0
:
kernel7-v0.1.0.tar.gz
kernel7-v0.1.0.zip
In order to build and compress for the Raspberry Pi 4, compile with the following flag:
make RASPI_MODEL=4 release
It will produce the following for KERNEL_VERSION = 0.1.0
:
kernel8-v0.1.0.tar.gz
kernel8-v0.1.0.zip
Also, do the same for the armstub:
make RASPI_MODEL=4 release_armstub
It will produce the following for KERNEL_VERSION = 0.1.0
:
armstub-new-v0.1.0.tar.gz
armstub-new-v0.1.0.zip
- On GitHub, navigate to the main page of the repository.
- To the right of the list of files, click Releases or Latest release.
- Click Draft a new release.
- In the version field, add the same version number as the compressed images (e.g.
v0.1.0
) - Use the drop-down menu to select the
main
branch, in order to release it. - Type a title and description for your release.
- Include the kernel compressed binaries and the armstub:
kernel7-vX.Y.Z.tar.gz
kernel7-vX.Y.Z.zip
kernel8-vX.Y.Z.tar.gz
kernel8-vX.Y.Z.zip
armstub-new-vX.Y.Z.tar.gz
armstub-new-vX.Y.Z.zip
- Select Create a discussion for this release, then select the Category drop-down menu and click a category for the release discussion.
- Click Publish release.
The GitHub's official guide for creating/editing/deleting releases in a repository:
Author: thanoskoutr
Wiki Documentation: https://github.com/thanoskoutr/armOS/wiki
Doxygen Documentation: https://thanoskoutr.github.io/armOS/