Currently, there is no straightforward way in distribute_options.yaml to include non-asset files (like LICENSE.txt, README.md, or third-party configuration files) directly into the root directory of the generated distribution package (e.g., Windows MSI/EXE, Linux DEB).
For desktop applications, including an Open Source License file in the installation directory is a mandatory legal requirement for many packages (e.g., those under LGPL, MIT, or Apache licenses).
Proposal
Please add an extra_files or include section within the package or job configuration in distribute_options.yaml.
This section should allow mapping local files to a destination path within the final build output.
- name: release-windows
package:
platform: windows
target: exe
# Proposed new section:
include_files:
- source: LICENSE_DIST.txt
destination: OPEN_SOURCE_LICENSES.txt
- source: docs/manual.pdf
destination: manual.pdf
Behavior
Specified files are included in the root directory of the generated distribution package
Benefits
This is particularly important for compliance with the LGPL v3 license (often used with C-library wrappers), which requires "prominent notice" and easy access to the license text and the source code location within the distributed software package.
Currently, there is no straightforward way in
distribute_options.yamlto include non-asset files (like LICENSE.txt, README.md, or third-party configuration files) directly into the root directory of the generated distribution package (e.g., Windows MSI/EXE, Linux DEB).For desktop applications, including an Open Source License file in the installation directory is a mandatory legal requirement for many packages (e.g., those under LGPL, MIT, or Apache licenses).
Proposal
Please add an
extra_filesorincludesection within the package or job configuration indistribute_options.yaml.This section should allow mapping local files to a destination path within the final build output.
Behavior
Specified files are included in the root directory of the generated distribution package
Benefits
This is particularly important for compliance with the LGPL v3 license (often used with C-library wrappers), which requires "prominent notice" and easy access to the license text and the source code location within the distributed software package.