Skip to content

V9.1 - Streamlined Environment Setup and Enhanced Metric Thresholds

Compare
Choose a tag to compare
@BrenoFariasdaSilva BrenoFariasdaSilva released this 24 Dec 20:13
· 122 commits to main since this release

Summary

This release focuses on streamlining the environment setup process and refining threshold-based metrics functionality in the Worked-Example-Miner (WEM) project. Key updates include improved handling of environment variables, expanded setup automation, and enhanced metric thresholds for more precise analysis of code candidates.

Key Improvements

Enhanced Setup Automation:

  • Refined install_requirements.sh to verify package availability and handle critical dependencies like build-essentials, venv, and Java.
  • Introduced improved handling and validation of the JAVA_HOME environment variable for a smoother setup process.
  • Updated the setup script to include clear and concise messages for better user guidance.

Documentation Improvements:

  • Added detailed sections in the README for setting up JAVA_HOME, C/C++ compilers, and Python virtual environments.
  • Addressed missing information about required packages, enhancing clarity for new users.

Metric Threshold Features:

  • Introduced dictionaries for minimum and maximum metric value thresholds to metrics_changes.py.
  • Added maximum threshold functionality for identifying code candidates with metric decreases over time.

Bug Fixes:

  • Resolved issues with setting and updating the DEFAULT_REPOSITORIES dictionary across various modules.
  • Fixed parameter defaults in key functions like generate_tasks_description and RUN_FUNCTIONS.

Refinements in PyDriller:

  • Optimized repository processing functions to return structured dictionaries.
  • Improved welcome and process list messages for better user experience and feedback.

Important Notes

  • Users are encouraged to update their local repositories to leverage the streamlined setup and enhanced analysis capabilities introduced in this release.
  • Ensure all dependencies are met using the updated install_requirements.sh script for optimal functionality.

Full Changelog: v9.0...v9.1