3. Incorporate cargo-about for Third-Party License Generation and Adding License Files to Release Artifacts in the uobors_cli project#

Date: 2024-03-23

Status#

Accepted

Context#

In the uobors_cli project, we need a way to generate third-party licenses and include them in our release artifact zip file.

Decision#

We decided to use cargo-about to generate third-party licenses for the uobors_cli project. This tool automatically generates an html file containing the software licenses of all dependencies.

In addition, we decided to include the license files in the release artifact zip file of the uobors_cli project. It ensures that the licenses are distributed with the software, complying with the license requirements of our dependencies.

Consequences#

We can automate the generation of third-party licenses by using cargo-about in the uobors_cli project. It reduces the risk of missing a license and makes it easier to update the licenses when our dependencies change.

Including the license files in the release artifact zip file of the uobors_cli project ensures distribution with the software. It helps us comply with the license requirements of our dependencies.

However, this also increases the size of the release artifact zip file. It is an acceptable trade-off for ensuring license compliance in the uobors_cli project.