3.4.0 - 2024-07-04

Release Notes

Hipcheck 3.4.0 is an exciting release featuring 3 new subcommands!

• hc setup: When you install the hc binary, whether through an install
  script with a release, with cargo binstall, or by building it yourself,
  you still need to get the configuration and data files Hipcheck requires.
  This new command gets those files for you, so you can start using Hipcheck
  quickly and easily!
• hc update: This lets Hipcheck update itself to newer versions! Under the
  hood, we're using the self-updater built and provided by cargo-dist, the
  tool we use for cutting new releases with prebuilt binaries. The hc update
  command is a wrapper around that updater. This command does require that
  you use our install script to get the self-updater.
• hc scoring: This tells you how Hipcheck is scoring results based on your
  current configuration. While you can see the weights for each analysis in
  your configuration file, it can be tedious to do the math yourself to find
  out exactly how much each analysis contributes to the overall score. This
  command does that math for you to make it easier.

Hipcheck also now has an official website!
Feel free to check it out, and let us know if you encounter any issues with it.

Added

• Add new hc setup command:
  • Add hc setup installation command by @j-lanson
  • Slightly modified arguments for hc setup by @alilleybrinker in #155
• Add new hc update command:
  • Adds hc update command to run the self-updater (if installed) to automatically bring Hipcheck up to date with a released version. Includes optional flags to update to versions other than the latest by @mchernicoff in #176
• Add new hc scoring command:
  • Scoring subcommand by @vcfxb in #170

Changed

• Refactor analyses and scoring to prepare for future migration to a plugin system:
  • Add weight tree and replace old scoring by @j-lanson in #160
  • Replace prior AnalysisResults obj with AltAnalysisResults impl by @j-lanson in #159
  • Demonstrate use of hashmap with new result objects for analysis storage by @j-lanson in #130
  • refactor affiliation analysis, experiment with macro by @j-lanson in #154
  • refactor all remaining repo analyses by @j-lanson in #157
• Improve Hipcheck performance:
  • Parallelize grapheme collection across files by @alilleybrinker in #146
  • Crate features for benchmarking and new Drop based benchmarking struct by @vcfxb in #136
• Clean out dependencies we no longer need:
  • Remove unused tempdir dependency by @vcfxb in #145
  • Remove dependency on lazy static by @vcfxb in #147
• Improve Hipcheck container image:
  • Use Debian base image instead of Alpine by @cstepanian in #180
  • Clean apt cache after installation by @cstepanian in #181
• Keep dependencies up-to-date:
  • Bump lazy_static from 1.4.0 to 1.5.0 by @dependabot[bot] in #142
  • Bump proc-macro2 from 1.0.85 to 1.0.86 by @dependabot[bot] in #141
  • Bump syn from 2.0.66 to 2.0.68 by @dependabot[bot] in #140
  • Bump dashmap from 5.5.3 to 6.0.1 by @dependabot[bot] in #164
  • Bump log from 0.4.21 to 0.4.22 by @dependabot[bot] in #165
  • Bump serde_json from 1.0.117 to 1.0.119 by @dependabot[bot] in #163
  • Bump ordered-float from 4.2.0 to 4.2.1 by @dependabot[bot] in #166
  • Bump clap from 4.5.7 to 4.5.8 by @dependabot[bot] in #162

Fixed

• Fix broken Docker build:
  • Vendor libgit2 and openssl so that hipcheck builds in containers more consistently by @vcfxb in #177

Removed

• Remove legacy CLI features that aren't actually implemented or supported:
  • Removes patch type as option for hc check or hc schema, as that was unsupported by @mchernicoff in #153
  • Remove pr analysis and scoring infrastructure by @j-lanson in #158

New Contributors

• @cstepanian made their first contribution in #181

Full Changelog: hipcheck-v3.3.2...hipcheck-v3.4.0

Install hipcheck 3.4.0

Install prebuilt binaries via shell script

curl --proto '=https' --tlsv1.2 -LsSf https://github.com/mitre/hipcheck/releases/download/hipcheck-v3.4.0/hipcheck-installer.sh | sh

Install prebuilt binaries via powershell script

powershell -c "irm https://github.com/mitre/hipcheck/releases/download/hipcheck-v3.4.0/hipcheck-installer.ps1 | iex"

Download hipcheck 3.4.0

File	Platform	Checksum
hipcheck-aarch64-apple-darwin.tar.xz	Apple Silicon macOS	checksum
hipcheck-x86_64-apple-darwin.tar.xz	Intel macOS	checksum
hipcheck-x86_64-pc-windows-msvc.zip	x64 Windows	checksum
hipcheck-x86_64-unknown-linux-gnu.tar.xz	x64 Linux	checksum