Skip to content

Latest commit

 

History

History
121 lines (88 loc) · 4.75 KB

README.md

File metadata and controls

121 lines (88 loc) · 4.75 KB
Raw

meta-dts

You can find documentation about the DTS system, including information on building the system, running the system, and the functionalities included in the system, by visiting the following links.

Please visit release section to get latest version of DTS.

Communication channel

We have created communication channels to provide support to our community. Please look there if you are looking for help regarding DTS system or any Dasharo related stuff.

Reporting issues

Thank you for using Dasharo Tools Suite Community Edition. If you have encountered any problems with this version, or would like to provide feedback for us - please open an issue on dasharo-issues repository.

Release process

This section contains the technical aspects of the DTS release process. The recipients of this information should be those authorised to issue DTS releases.

The basic release process can be found here

Follow the first 6 steps from the document linked above. The remaining steps will be performed automatically by CI. The pipeline of creating a DTS release consists of two steps.

  • The first step is done on GitHub Actions. Here the DTS image is built and the binaries are pushed to boot.dasharo.com.

  • The second step is done on Gitea Actions. There the ipxe menu is pushed to boot.3mdeb.com and the binaries are signed. Additionally, CI publishes the release on https://github.com/Dasharo/meta-dts/releases, from where binaries can be downloaded.

When generating the changelog, you can provide your GitHub access token as a parameter to generate-changelog.sh. This will increase the cap on API call rate, which may otherwise prevent you from running git cliff.

Cukinia tests

DTS utilizes the cukinia framework to test various features and tools integrated into the system. You can execute the tests using the following command in the DTS shell:

cukinia

It is recommended that you run the tests when developing DTS to make sure that the features are still working after your changes.

Developing cukinia tests

When integrating new features into DTS, one should add tests to check whether the changes work. The test cases are located in meta-dts-distro/recipes-tests/dts-tests/dts-tests/cukinia.conf. The following example shows test cases that could be added after adding a new binary/script to DTS.

as "Check if script X exists" cukinia_test -x $(which <script_name>)
as "Check if script X can be executed" cukinia_cmd <script_name> --help

Testing Dasharo firmware updates from local sources

By default the DTS uses https://3mdeb.com/open-source-firmware/Dasharo as a source of downloaded artifacts in case of community releases. This behaviour can be changed by starting dts script from the command line with FW_STORE_URL_DEV variable set to the http address that is serving the update files.

Below there is a list of steps that one need to do, to fetch binaries from local server.

  1. On host PC create dasharo-updates directory and from it start the http python module, as a port you can use e.g. 1234.

    mkdir dasharo-updates && cd dasharo-updates
python -m http.server 1234

  2. Inside dasharo-updates directory create the same folder structure as there is for your update files on https://3mdeb.com/open-source-firmware/Dasharo. E.g. for v1.7.2 of NovaCustom NS5X ADL you need to create path novacustom_ns5x_adl/v1.7.2/ and inside put binaries, hashes and signatures from that release.

  3. Boot DTS and start shell by pressing 9.

  4. Start dts script with FW_STORE_URL_DEV variable set to started server on the host PC. E.g. if the PC has IP address 192.168.1.14 use below command.

    FW_STORE_URL_DEV="http://192.168.1.14:1234" dts

  5. Normal dts menu entry will be displayed but any request to the server with binaries will be done to http://192.168.1.14:1234 instead of https://3mdeb.com/open-source-firmware/Dasharo.