v2.0.2

Multicast v2.0.2 Release Notes

This release focuses on enhancing the functionality, security, and documentation of the multicast project by addressing multiple issues, improving error handling, updating dependencies, and adding new features.

Fixes

• Security Fixes:

  • Mitigated command injection vulnerability in tests/check_pip script by sanitizing inputs and improving cleanup processes. (Issue #197)
  • Validated YAML_ARGS in makefile-lint.yml to prevent command injection vulnerabilities. (Issue #196)

• Error Handling Improvements:

  • Handled UnicodeDecodeError in HearUDPHandler to improve robustness against malformed input. (Issue #188)
  • Added input validation for the DOCS_BUILD_REF environment variable in docs/conf.py. (Issue #189)
  • Fixed shell script syntax in the error handling block of makefile-lint.yml. (Issue #200)

• Testing Enhancements:

  • Investigated and addressed flaky tests in tests/test_fuzz.py. (Issue #217)

• Maintenance:

  • Enhanced virtual environment cleanup in tests/check_pip script. (Issue #198)
  • Refactored check_license_when_given_req function for better maintainability. (Issue #191)

New Features

• Package Management:
  • Implemented package.json for managing npm dependencies, enabling better management of JavaScript-related tooling. (Issue #214)

Documentation

• Guides and References:
  • Added docs/Exception_Guide.md providing a comprehensive guide on error handling and exceptions within the project.
  • Updated README.md with a new logo and updated copyright year.
  • Enhanced contributing guidelines in .github/CONTRIBUTING.md with clearer instructions for reporting issues and submitting pull requests.
  • Updated docs/USAGE.md, docs/FAQ.md, docs/CI.md, and docs/toc.md to reflect the latest changes and improve clarity.
  • Added images and visual aids to documentation files for better understanding.

Refactors

• Codebase Improvements:
  • Standardized error handling in makefile-lint.yml by introducing a print_error function for consistent error reporting.
  • Updated docs/conf.py by adding _validate_git_ref function to ensure Git references are valid.
  • Refactored code to support Python 3.13 and updated minimum required versions.

Chores

• Dependency Updates:

  • Added Dependabot configuration for npm packages in .github/dependabot.yml to automate dependency updates. (Issue #220)
  • Updated setup.cfg, setup.py, requirements.txt, and package.json to reflect new version and dependency changes.

• Workflow Enhancements:

  • Updated GitHub Actions workflows:
    • Improved CI workflow documentation in .github/workflows/Tests.yml.
    • Updated .github/workflows/markdown-lint.yml and .markdownlint.yaml configurations for better linting support.
    • Added scorecard.yml workflow for scorecard analysis.

• Version Bump:

  • Updated version number to 2.0.2 across relevant files.

---

Full Changelog: v2.0.1...v2.0.2