Skip to content

CHANGES.md

Latest commit

 

History

History
138 lines (102 loc) · 4.78 KB

CHANGES.md

File metadata and controls

138 lines (102 loc) · 4.78 KB
Raw

Notable Changes

Note: Changes should be grouped by release and use these icons:

  • Added: ➕
  • Changed: 🌌
  • Deprecated: 👇
  • Removed: ❌
  • Fixed: 🐛
  • Security: 🛡

Version 0.5.0

➕ Support for downloading recipe source code using Git.

Added a new source field for recipe YAML files. source should contain one of:

  • uri: This is equivalent to the legacy url field.
  • git: A URL to clone a Git repository. May be either git@ or https://.

If git is used, you must additionally specify one of:

  • branch
  • tag

For example:

source:
  git: "https://github.com/Cisco-Talos/clamav.git"
  branch: main

Or, instead of this:

url: "https://github.com/Cisco-Talos/clamav/releases/download/clamav-1.5.1/clamav-1.5.1.tar.gz

Do this:

source:
  uri: "https://github.com/Cisco-Talos/clamav/releases/download/clamav-1.5.1/clamav-1.5.1.tar.gz

Deprecated the url field in favor of using source with uri. url may be removed in a future release.

Version 0.4.2

🐛 Remove dependency on deprecated pkg_resources package to ensure compatibility with future Python versions.

Version 0.4.1

🐛 Fixed an issue using pkg_resources package when setuptools is not installed. The fix adds setuptools as a dependency.

Version 0.4.0

Added

➕ Added support for extracting .tar.xz source archives, in addition to .tar.gz and .zip archives.

Version 0.3.0

Added

➕ Added the ability to define variables in tools that can be accessed in recipes.

To define variables, add a variables list for each platform.

This feature was inspired by a need to make recipes that have strings in them specific to a given tool version. Specifically we'll be using this to define CMake generator names in Visual Studio tool YAML files. The correct generator name for a given Visual Studio version will then be available for use in recipes that use Visual Studio.

Example tool, visualstudio-2017.yaml:

name: visualstudio
version: "2017"
mussels_version: "0.3"
type: tool
platforms:
  Windows:
    file_checks:
      - C:\/Program Files (x86)/Microsoft Visual Studio/2017/Professional/VC/Auxiliary/Build/vcvarsall.bat
      - C:\/Program Files (x86)/Microsoft Visual Studio/2017/Enterprise/VC/Auxiliary/Build/vcvarsall.bat
      - C:\/Program Files (x86)/Microsoft Visual Studio/2017/Community/VC/Auxiliary/Build/vcvarsall.bat
    variables:
      cmake_generator: Visual Studio 15 2017

Example recipe, libz.yaml:

name: libz
version: "1.2.11"
url: https://www.zlib.net/zlib-1.2.11.tar.gz
mussels_version: "0.3"
type: recipe
platforms:
  Windows:
    x64:
      build_script:
        configure: |
          CALL cmake.exe -G "{visualstudio.cmake_generator} Win64"
        make: |
          CALL cmake.exe --build . --config Release
      dependencies: []
      install_paths:
        include:
          - zlib.h
          - zconf.h
        lib:
          - Release/zlibstatic.lib
        license/zlib:
          - README
      required_tools:
        - cmake
        - visualstudio>=2017

🐛 Fixed a crash caused by a failure to properly decode command output text from some locales to utf8.

Version 0.2.1

➕ Added the Mussels version string to the msl --help output.

➕ Added msl build options allowing users to customize the work, logs, and downloads directories:

  • -w, --work-dir TEXT Work directory. The default is: ~/.mussels/cache/work
  • -l, --log-dir TEXT Log directory. The default is: ~/.mussels/logs
  • -D, --download-dir TEXT Downloads directory. The default is: ~/.mussels/cache/downloads

🐛 The msl build -c shorthand for --cookbook was overloaded by the --clean (-c) shorthand. Because --cookbook (-c ) is also used elsewhere, the --clean option was renamed to --rebuild (-r).

🐛 Fixed an issue where the list of available tools was being limited based on all recipe tool version requirements rather than just those found in the dependency chain.

Version 0.2.0

➕ Added the msl build --install/-i option, allowing builds to install directly to a directory of the user's choosing.

🌌 The {install} build script variable now points to the full install prefix, including the target architecture directory when building with the default install directory (eg: host, x86, x64, etc).

This was necessary in order for the --install option to make sense. This also simplifies recipes because they no longer have to specify "{install}/{target}" to reference the install directory. This, unfortunately, also makes it a breaking change. All recipes will have to remove the "/{target}" to remain compatible.

Version 0.1.0

➕ First release!