v2.1.0a1

Minor Stability fix and version bump

Full Changelog: v2.0.9...v2.1.0a1

v2.0.9

Version 2.0.9 Release Notes

What Changed between v2.0.8...v2.0.9

Details
Kinds of changes	UPDATE, STYLE, SECURITY, RELEASE, PATCH, MERGE, LICENSE, HOTFIX, FIX, FEATURE, DOCUMENTATION, DOCUMENTAITON, DEBUG, COVERAGE, CONFIG, COMMENT, CI
Impacted Issues	#130, #155, #203, #216, #242, #274, #282, #314, #335, #338, #339, #367, #388, #392, #395, #396, #397, #400, #401, #402, #403, #404, #405, #406, #407, #408, #409, #410, #411, #412, #413, #414, #415, #419, #420, #425, #426, #427, #429, #433, #434, #439, #441, #442, #443, #444, #446, #448, #452, #454, #455
New Files	docs/INSTALL.md, docs/SECURITY.md, docs/Testing.md, generate_changelog.sh, .github/actions/check-control/action.yml, .github/actions/checkout-and-rebuild/action.yml, .github/actions/fetch-test-reporter/action.yml, .github/actions/run-minimal-acceptance-tests/action.yml, .github/actions/setup-py-reqs/action.yml, .github/actions/test-reporter-upload/action.yml, .github/AI_USAGE_POLICY.md, .github/tools/fetch-test-reporter, .github/workflows/CD-PyPi.yml, .github/workflows/CI-CHGLOG.yml, .gitmodules
Removed Files	setup.cfg, setup.py, tests/check_legacy_setup_coverage, tests/test_install_requires.py

Changes in file .coderabbit.yaml:

• reviewed and approved sugested grammar changes (see AI policy requirements for changes)
• related work (added missing commas)
• no functional change
• minor style changes
• minor related changes
• improved path_filter
• improved directions a bit
• implemented approved grammar changes

Changes in file .deepsource.toml:

• removed setup.py from dependency sources

Changes in file docs/CI.md:

• updated Triggering CI/CD with CI-CHGLOG
• updated theme for diagrams for darkmode
• updated license url
• updated Key integrations section with CI-CHGLOG
• updated 'How on-workflow_run triggers propagate' section with CI-CHGLOG
• updated CI/CD documentation to mention new GHA CI-CHGLOG
• updated CI docs with notes about linting in CI
• Switched License badge
• style changes
• reworked mermaid diagrams
• reworded several parts for accuracy.
• restyled numbering
• re-structured headings for consistancy
• removed def quote (only one is inconsistant)
• removed CodeClimate mentions
• remove the indents
• remove testing documentation from CI documentation.
• related work
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• possible fix for MD029 (- WIP pR #420 -)
• other style changes
• minor changes for grammer and consistancy
• initial draft of documentation for CI/CD acceptance testing components.
• improved readability slightly
• improved CI/CD documentation from #410
• fixed some typos
• fixed an overlooked typo
• cleaned up formatting a little
• attempt to wrap long lines with long link 🤷
• added some more details about CI/CD
• added new triggering CI/CD section with initial notes.
• added missing 'the'
• A few more style changes to cleanup the document

Changes in file docs/conf.py:

• Version bump to v2.0.9a8
• version bump to v2.0.9a8
• version bump to v2.0.9a7
• version bump to v2.0.9a6
• version bump to v2.0.9
• version bump
• "selectively" fixed a typo
• related work
• Preserved the existing tab indentation as required by CEP-8 for consistancy
• possible improvement for mermaid theme
• other minor changes
• minor debugging of new doctests
• fixed so linkcode_resolve doctests now pass
• fix for regression caused by last set of changes to docstrings
• enabled mermaid zoom by default
• configure sphinxcontrib-mermaid plugin
• bumped version to 2.0.9
• added some docstrings to linkcode_resolve

Changes in file docs/Environment_Configuration.md:

• updated license urls
• Switched License badge
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/Exception_Guide.md:

• updated license urls
• Switched License badge
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/FAQ.md:

• various improvements
• updated license url
• Switched License badge
• style fixes
• simplified code examples some more
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• multiple minor rewordings
• minor changes
• improved readability slightly
• added list of some key project policies for contributors
• added answer about use of logging handlers

Changes in file docs/index.md:

• updated license url
• Switched License badge
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/INSTALL.md:
Additions with file docs/INSTALL.md:

• style sync
• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• markdown style tweak
• initial draft of INSTALL guide
• added missing copyright line

Changes in file docs/Makefile:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/requirements.txt:

• version bumps
• version bump for pip and related
• version bump
• updated license urls
• remove duplicates
• related comments
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• added notes about various licenses
• add documentaion dep sphinxcontrib-mermaid (MIT/BSD like license)

Changes in file docs/SECURITY.md:
Additions with file docs/SECURITY.md:

• style fixes for very long lines
• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• minimal Draft for SECURITY
• added missing copyright comment line

Changes in file docs/Testing.md:
Additions with file docs/Testing.md:

• updated theme for diagrams for darkmode
• updated license urls
• style changes
• re-worded some
• related work.
• related work
• related changes
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• re-drafted previous documentation about project testing.
• new documentation about testing from #411
• Many style fixes
• Improved markdown style
• improved documentation regarding testing a bunch
• added missing comma
• added "Dependencies NOT included." for clearity

Changes in file docs/toc.md:

• updated license url
• Switched License badge
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• added new Testing link to ToC

Changes in file docs/USAGE.md:

• updated usage docs for new '--pipe' option
• updated license url
• updated for new --pipe flag as part of GHI #216
• Switched License badge
• style fixes
• simplified some code examples even more
• related style fixes
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• more white-space style fixes
• minor reworking of header style
• minor reworking of header orginization

Changes in file docs/utils.py:

• updated license url
• related work
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• improved to normalize netloc and path components of URLs
• improved inline comment to mention "normalize" "to prevent homograph attacks"
• hardened slugify_header to also normalize unicode
• corrected misleading type hints/annotations to use the better 'frozenset' type for whitelisting
• added gists to url list

Changes in file generate_changelog.sh:
Additions with file generate_changelog.sh:

• style improvements
• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• refactored for security hardening
• now generates new changelog from scratch if given no options
• now extracts impacted issues and kinds of changes as well as per-file changes
• minor last-minute style improvements
• minor change to quoting
• major performance improvements about 25 times faster now
• initial implementation
• improved stability in pre-flight checks
• improved initial formatting a bit
• improved comments
• imporved details table
• hardened recursive calls
• added validation of git range input
• added some caching while re-generationg
• added setting the locals for sort to the setup before generating changelogs
• added optional verbose mode
• added link to full changelog view on github

Changes in file .gitattributes:

• removed redundant rules
• overhauled with a more modern template from y.m.m.v.
• added some comments

Changes in file .github/actions/check-control/action.yml:
Additions with file .github/actions/check-control/action.yml:

• use single quotes for possible markdown content
• ✨ New WIP GHA template to better control expected checks from CI/CD
• related work
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• minor improvements to stability
• improved readability slightly

Changes in file .github/actions/checkout-and-rebuild/action.yml:
Additions with file .github/actions/checkout-and-rebuild/action.yml:

• use input token for verifing attestation too
• use env for values instead of API
• updated artifact pattern to align with recent changes to CI-MATs.yml
• revert to use python for pip-upgrade on windows in CI/CD, because it buggs out on windows paths in bash
• removed manula verification as the download workflow is already checking the digest of the zip and fetching from the exact workflow by ID
• related work
• reformat build details so they can be hidde...

v2.0.9a8

What Changed between v2.0.9a6...v2.0.9a8

Details
Kinds of changes	UPDATE, STYLE, PATCH, MERGE, LICENSE, HOTFIX, FIX, DEBUG, COVERAGE, CONFIG, COMMENT, CI
Impacted Issues	#155, #335, #429, #434, #439, #441, #442, #443, #444, #446, #448, #452, #454, #455

Changes in file .coderabbit.yaml:

• reviewed and approved sugested grammar changes (see AI policy requirements for changes)
• minor style changes
• improved path_filter
• improved directions a bit
• implemented approved grammar changes

Changes in file docs/CI.md:

• removed CodeClimate mentions
• other style changes
• improved readability slightly

Changes in file docs/conf.py:

• Version bump to v2.0.9a8
• version bump to v2.0.9a8
• version bump to v2.0.9a7

Changes in file docs/FAQ.md:

• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• improved readability slightly

Changes in file docs/INSTALL.md:

• style sync
• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• markdown style tweak
• added missing copyright line

Changes in file docs/requirements.txt:

• version bump for pip and related
• version bump

Changes in file docs/SECURITY.md:

• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• added missing copyright comment line

Changes in file docs/USAGE.md:

• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"

Changes in file generate_changelog.sh:

• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• minor change to quoting
• added setting the locals for sort to the setup before generating changelogs

Changes in file .gitattributes:

• removed redundant rules
• added some comments

Changes in file .github/actions/check-control/action.yml:

• minor improvements to stability
• improved readability slightly

Changes in file .github/actions/checkout-and-rebuild/action.yml:

• use input token for verifing attestation too
• revert to use python for pip-upgrade on windows in CI/CD, because it buggs out on windows paths in bash
• removed manula verification as the download workflow is already checking the digest of the zip and fetching from the exact workflow by ID
• minor changes
• improved python setup to include environment overrides
• attempt to convert windows python path

Changes in file .github/actions/fetch-test-reporter/action.yml:

• minor cleanup
• improved use of deprecationMessage
• EoL CodeClimate Support

Changes in file .github/actions/purge-test-reporter/action.yml:

• minor re-wording
• minor cleanup
• improved use of deprecationMessage
• EoL CodeClimate Support

Changes in file .github/actions/run-minimal-acceptance-tests/action.yml:

• minor improvements to stability

Changes in file .github/actions/test-reporter-upload/action.yml:

• skip some checks on windows runners
• override brnach name in coverage reports
• minor improvements to stability
• improved use of deprecationMessage
• EoL CodeClimate Support

Changes in file .github/AI_USAGE_POLICY.md:

• improved readability slightly

Changes in file .github/CONTRIBUTING.md:

• improved readability slightly

Changes in file .github/dependabot.yml:

• regression fix
• minor change
• changes to better reflect dependencies

Changes in file .github/ISSUE_TEMPLATE.md:

• improved readability slightly

Changes in file .github/labeler.yml:

• improved labeling some

Changes in file .github/workflows/CI-BUILD.yml:

• version bump
• store PR number in the build info for use in reports
• small style changes
• possible regression fix
• minor improvements to stability
• minor improvements
• minor fixes
• improved python bootstrapping a little
• corrected comment to version 2.4.0 for e8998f949152b193b063cb0ec769d69d929409be (attest-build-provenance)
• changed gh pr call to use gh api call
• added fr_CA.UTF-8 to build testing
• add pr number details to build info

Changes in file .github/workflows/CI-CHGLOG.yml:

• refactored old slug "reactive-firewall/multicast" to new slug "reactive-firewall-org/multicast"
• Corrected runtime temp path value

Changes in file .github/workflows/CI-DOCS.yml:

• minor improvements to stability

Changes in file .github/workflows/CI-MATs.yml:

• minor improvements to stability
• add pr number details to build info

Changes in file .github/workflows/codeql-analysis.yml:

• version bumps
• version bump for CodeQL
• version bump

Changes in file .github/workflows/flake8.yml:

• version bump from v1.3 to v1.5
• fixed comment for new version

Changes in file .github/workflows/scorecard.yml:

• version bump for CodeQL
• version bump
• minor changes
• version bumps

Changes in file .github/workflows/Tests.yml:

• when using spaces (in YAML) should be increments of 2 (8 or 10, instead of 9)
• removed direct file-upload of coverage, in-favor of test-reporter-upload step
• related refactoring
• refactored erronious condition
• override brnach name in coverage reports
• minor stability improvements to coverage reporting and tox job setup.
• minor improvements
• minor changes
• major improvements to stability (WIP)
• improved setup for tox hopefully
• EoL CodeClimate Support
• cover both test modes for coverage now
• added bypass for invalid success logic
• add pr number details to codecov coverage upload

Changes in file LICENSE.md:

• updated URL
• updated a few more licences to direct links
• improved readability slightly

Changes in file Logo.svg:

• improved readability slightly

Changes in file Makefile:

• version bump for pip and related
• overhauled tox based testing support
• other style changes
• minor changes for tox support
• improvements to tox based testing optional case
• improvement to coverage logic slightly
• improved style check stability slightly
• improved coverage reporting for tests
• improved coverage reporting for just-test target

Changes in file multicast/hear.py:

• removed commented out code to suppress PY-W0069
• other minor changes
• minor style refactoring for over-zelous linter
• minor style refactor
• minor style change
• minor coverage tweaking
• linter churn
• added doctest testcase for handler with STOP message

Changes in file multicast/init.py:

• version bump to v2.0.9-alpha-7
• Version bump to v2.0.9a8
• version bump to v2.0.9a8
• style tweaks
• possible fix for PYL-R0401
• minor style refactoring for over-zelous linter
• minor style change to suppress PYL-R0401
• added some documentation

Changes in file multicast/main.py:

• style tweaks
• minor coverage tweaking
• linter churn
• improved code style
• Fixed typo found, but regressed in #429
• added some documentation

Changes in file multicast/recv.py:

• style tweaks
• added some documentation

Changes in file multicast/send.py:

• improved code style

Changes in file multicast/skt.py:

• style tweaks

Changes in file pyproject.toml:

• Version bump to v2.0.9a8
• version bump to v2.0.9a8
• version bump to v2.0.9a7
• fixed a version typo

Changes in file README.md:

• ❇️ added new Badges
• removed CodeClimate Badges
• removed another missed badge
• minor tweak to example
• improved readability slightly

Changes in file tests/requirements.txt:
Changes in file requirements.txt:
Changes in file docs/requirements.txt:

• vrsion bump
• version bump for pip and related
• version bump

Changes in file tests/check_pip:

• Workaround for pycodestyle ("MIT")

Changes in file tests/context.py:

• style tweaks
• linter churn
• Fixed typo found, but regressed in #429
• added some documentation

Changes in file tests/init.py:

• style tweaks
• minor style refactoring for over-zelous linter
• minor fixes
• improved doctests slightly
• added some documentation

Changes in file tests/MulticastUDPClient.py:

• style tweaks
• fixed a version header

Changes in file tests/profiling.py:

• updated URL
• updated python-repo licences to direct link

Changes in file tests/requirements.txt:

• vrsion bump
• version bump for pip and related

Changes in file tests/test_basic.py:

• updated python-repo licences to direct link
• fixed a version header
• updated URL

Changes in file tests/test_build.py:

• updated python-repo licences to direct link
• small improvement to docstrings
• fixed a version header
• updated URL

Changes in file tests/test_deps.py:

• fixed a version header

Changes in file tests/test_extra.py:

• regression fix for optional missing case
• minor style changes
• added some documentation
• added doctest for decorator

Changes in file tests/test_fuzz.py:

• added some documentation

Changes in file tests/test_hear_cleanup.py:

• small improvement to docstrings
• skip early if send fails in flaky test
• re-re-re fix for misleading comments
• regression fix for optional missing case
• new test for negitive case
• minor style changes
• improved code coverage
• corrected an overlooked comment

Changes in file tests/test_hear_keyboard_interrupt.py:

• minor style changes

Changes in file tests/test_hear_server_activate.py:

• style tweaks
• added some documentation

Changes in file tests/test_hear_server.py:

• style tweaks
• small improvement to docstrings
• added some documentation

Changes in file tests/test_manifest.py:

• minor style changes

Changes in file tests/test_usage.py:

• updated python-repo licences to direct link
• style tweaks
• added some documentation
• updated URL

Changes in file tox.ini:

• version bumps for v...

YANK v2.0.9a7

Known flaws.

Warning

This commit has known flaws. Each commit is subject to minimal acceptance testing, and then select commits are subject to extra testing to evaluate release candidates; This commit has been deemed not ready for release.

v2.0.9a6

What Changed between v2.0.9a6...v2.0.9a5

• Feature render mermaid diagrams in sphinx docs as GFM does by @reactive-firewall in #426
• Hardened documentation a little by normalizing unicode when sanitizing by @reactive-firewall in #427
• [UPDATE] (deps): Bump ossf/scorecard-action from 2.4.1 to 2.4.2 in /.github/workflows by @dependabot in #428
• Improved FAQ documentation some more by @reactive-firewall in #429
• Feature automate change-log by @reactive-firewall in #433

Details
Kinds of changes	UPDATE, STYLE, SECURITY, PATCH, MERGE, LICENSE, HOTFIX, FEATURE, DOCUMENTATION, CONFIG
Impacted Issues	#155, #274, #314, #335, #413, #425, #426, #427, #429, #433, #434
New Files	docs/INSTALL.md, docs/SECURITY.md, generate_changelog.sh, .github/workflows/CI-CHGLOG.yml

Changes in file docs/CI.md:

• updated Triggering CI/CD with CI-CHGLOG
• updated theme for diagrams for darkmode
• updated license url
• updated Key integrations section with CI-CHGLOG
• updated 'How on-workflow_run triggers propagate' section with CI-CHGLOG
• updated CI/CD documentation to mention new GHA CI-CHGLOG
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• fixed an overlooked typo

Changes in file docs/conf.py:

• version bump to v2.0.9a6
• "selectively" fixed a typo
• Preserved the existing tab indentation as required by CEP-8 for consistancy
• possible improvement for mermaid theme
• other minor changes
• minor debugging of new doctests
• fixed so linkcode_resolve doctests now pass
• fix for regression caused by last set of changes to docstrings
• enabled mermaid zoom by default
• configure sphinxcontrib-mermaid plugin
• added some docstrings to linkcode_resolve

Changes in file docs/Environment_Configuration.md:

• updated license urls
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/Exception_Guide.md:

• updated license urls
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/FAQ.md:

• various improvements
• updated license url
• style fixes
• simplified code examples some more
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• multiple minor rewordings
• added list of some key project policies for contributors
• added answer about use of logging handlers

Changes in file docs/index.md:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Additions with file docs/INSTALL.md:

• initial draft of INSTALL guide

Changes in file docs/Makefile:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/requirements.txt:

• updated license urls
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• add documentaion dep sphinxcontrib-mermaid (MIT/BSD like license)

Changes in file docs/SECURITY.md:
Additions with file docs/SECURITY.md:

• style fixes for very long lines
• minimal Draft for SECURITY

Changes in file docs/Testing.md:

• updated theme for diagrams for darkmode
• updated license urls
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/toc.md:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file docs/USAGE.md:

• updated license url
• style fixes
• simplified some code examples even more
• related style fixes
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• more white-space style fixes
• minor reworking of header style
• minor reworking of header orginization

Changes in file docs/utils.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• improved to normalize netloc and path components of URLs
• improved inline comment to mention "normalize" "to prevent homograph attacks"
• hardened slugify_header to also normalize unicode
• corrected misleading type hints/annotations to use the better 'frozenset' type for whitelisting

Changes in file generate_changelog.sh:
Additions with file generate_changelog.sh:

• style improvements
• refactored for security hardening
• now generates new changelog from scratch if given no options
• now extracts impacted issues and kinds of changes as well as per-file changes
• minor last-minute style improvements
• major performance improvements about 25 times faster now
• initial implementation
• improved stability in pre-flight checks
• improved initial formatting a bit
• improved comments
• imporved details table
• hardened recursive calls
• added validation of git range input
• added some caching while re-generationg
• added optional verbose mode
• added link to full changelog view on github

Changes in file .github/actions/check-control/action.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/actions/checkout-and-rebuild/action.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/actions/fetch-test-reporter/action.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/actions/purge-test-reporter/action.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/actions/run-minimal-acceptance-tests/action.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/actions/setup-py-reqs/action.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/actions/test-reporter-upload/action.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/CONTRIBUTING.md:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/tools/cioutput.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/workflows/CD-PyPi.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/workflows/CI-BUILD.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/workflows/CI-CHGLOG.yml:
Additions with file .github/workflows/CI-CHGLOG.yml:

• refactored for new GitHub workflow job naming convention
• Oops, almost missed an ID refactor
• Initial implementation of new CHANGELOG generating action in CI/CD
• fixed some minor overlooked mistakes found in review
• fixed a variable name
• add clear "contents: read" to permissions for checkout action

Changes in file .github/workflows/CI-DOCS.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/workflows/CI-MATs.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file .github/workflows/Tests.yml:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• minor hotfix for coverage testing to use bash shell

Changes in file LICENSE.md:

• updated license urls
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• minor rewording
• minor license updates for accuracy

Changes in file Logo.svg:

• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file Makefile:
Changes in file docs/Makefile:

• updated license url
• removed recursive txt include for builds
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file multicast/env.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file multicast/exceptions.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file multicast/hear.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file multicast/init.py:

• version bump to v2.0.9a6
• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file multicast/main.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file multicast/recv.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file multicast/send.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file multicast/skt.py:

• updated license url
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file pyproject.toml:

• version bump to v2.0.9a6
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"

Changes in file README.md:

• updated license urls
• refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
• fixed an overlooked typo
• added missing comma

Changes in file tests/requirements.txt:
Changes in file requirements.txt:
Changes in...

v2.0.9a5

Alpha 5 for Version 2.0.9 (v2.0.9a5) Patch Notes

Impacted GHI

• Closed #130

• followed up on #134
• Contributed to #155

• Closed #204
• Closed #126
• Closed #282
• Closed #338
• Closed #357
• Closed #367

• Opened #393
• Opened #394
• Opened #399

• Closed #400
• Closed #401
• Closed #403
• Closed #408
• Closed #410
• Closed #411

• Contributed to #412
• Opened #413

• Closed #417

• Opened #421
• Opened #425

Included and Superseded PRs

• Includes and Supersedes #392
• Includes and Supersedes #395
• Includes and Supersedes #396
• Includes and Supersedes #397
• Includes and Supersedes #402
• Includes and Supersedes #404
• Includes and Supersedes #405
• Includes and Supersedes #406
• Includes and Supersedes #407
• Includes and Supersedes #409
• Includes and Supersedes #414
• Includes and Supersedes #415
• Includes and Supersedes #416
• Includes and Supersedes #418
• Includes and Supersedes #419
• Includes and Supersedes #420
• Includes and Supersedes #422
• Includes and Supersedes #423
• Includes and Supersedes #424

What's Changed

Changes in file .coderabbit.yaml:

• related work (added missing commas)
• no functional changes

Changes in file .deepsource.toml:

• removed setup.py from dependency sources

Changes in file docs/CI.md:

• A few more style changes to cleanup the document
• added new triggering CI/CD section with initial notes
• added some more details about CI/CD
• attempt to wrap long lines with long link 🤷
• fixed some typos
• initial draft of documentation for CI/CD acceptance testing components
• minor changes for grammar and consistency
• remove testing documentation from CI documentation
• removed def quote (only one def is inconsistent)
• restyled numbering
• reworded several parts for accuracy
• reworked mermaid diagrams many times
• Switched License badge
• updated CI docs with notes about linting in CI

Changes in file docs/conf.py:

• bumped version to 2.0.9 series
• related work

Changes in file docs/Environment_Configuration.md:

• Switched License badge

Changes in file docs/Exception_Guide.md:

• Switched License badge

Changes in file docs/FAQ.md:

• Switched License badge
• a couple of minor changes

Changes in file docs/index.md:

• Switched License badge

Changes in file docs/requirements.txt:

• version bumps
• added notes about various licenses
• remove duplicates
• related comments

Additions with file docs/Testing.md:

• re-drafted previous documentation about project testing
• added "Dependencies NOT included." for clarity
• improved documentation regarding project testing
• Improved markdown style

Changes in file docs/toc.md:

• Switched License badge
• added new Testing link to ToC

Changes in file docs/USAGE.md:

• Switched License badge
• updated usage docs for new '--pipe' option

Changes in file docs/utils.py:

• added gists to url list
• related work

Changes in file .gitattributes:

• overhauled with a more modern template

Additions with file .github/actions/check-control/action.yml:

• ✨ New WIP GHA template to better control expected checks from CI/CD
• use single quotes for possible markdown content
• related work

Changes in file .github/actions/checkout-and-rebuild/action.yml:

• added logic to handle windows pip upgrade workaround
• moved summary to re-usable-action
• reformat build details so they can be hidden unless needed
• updated artifact pattern to align with recent changes to CI-MATs.yml
• use env for values instead of API

Additions with file .github/actions/fetch-test-reporter/action.yml:

• implemented fetch action of GHI #130
• added support for coveralls-token input

Additions with file .github/actions/run-minimal-acceptance-tests/action.yml:

• Initial implementation of template action to run more detailed MATs in CI/CD
• fix evaluation of MAT success and failure from inverted to intended.
• improved outputs a bit
• minor improvement for coverage reports
• minor performance tweaks (eg. printf is faster than echo)
• improved outputs a bit
• related work
• reworked logic for accepting input sha

Additions with file .github/actions/setup-py-reqs/action.yml:

• ✨ New action for handling python pip installs in CI/CD
• cleaned up a bunch and added comments
• related work

Additions with file .github/actions/test-reporter-upload/action.yml:

• New GHA action template to handle uploading coverage results to various services

Additions with file .github/AI_USAGE_POLICY.md:

• Documented initial draft of AI policy to communicate GHI #367 impact on project
• ✨ new policy for AI from #367

Changes in file .github/AI_USAGE_POLICY.md:

• added missing 'e' to use noun form
• added missing commas
• added note to better clearify 4.3.A
• changed the indentation
• cleanup for merging
• fixed large PR threshold at more than 99 changed files for consistancy
• fixed line length
• fixed use of "e.g."
• improvements based on review (- WIP PR #415 -)
• minor style fix
• new section for defining acronyms
• style fixes

Changes in file .github/CONTRIBUTING.md:

• reworded the review checklist
• improved contributors documentation

Changes in file .github/dependabot.yml:

• removed pytest-checkdocs which can't handle GFM markdown

Changes in file .github/labeler.yml:

• removed setup from "multicast" label
• added setup.py to "invalid" label

Changes in file .github/tools/checkmake.bash:

• related work (reorganized CI/CD tools)

Changes in file .github/tools/cioutput.py:

• removed layer of nesting argparse groups

Additions with file .github/tools/fetch-test-reporter:

• added submodule for implementing GHI #130

Changes in file .github/tools/shlock_helper.sh:

• related work

Additions with file .github/workflows/CD-PyPi.yml:

• ✨ added new action for CD

Changes in file .github/workflows/CI-BUILD.yml:

• ✨ added attestation details to build summary
• added default token for gh api usage
• added logic to post commit comment with build details
• added more build details to the BUILD-info.txt artifact
• added some debug code to failure cases
• comment via action if build success
• implemented uploading build info file for triggered builds
• improved readability of logs
• invert role of summary and buffer file
• lays groundwork for GHI #338
• make path to buffer file absolute
• additional outputs
• minor refactor for quoting
• minor tweak for build-info artifact
• minor update to tie license to build with attestation in CI/CD
• move path to env
• moved commit build details to build action
• Refactored to allow summary comment with updated permissions
• related work
• version bump for build-attesting
• added attest action for successful builds
  • limited to only attest the build per sha, not the built packages every time
  • limited to only attest build packages per tag, for protected tags pushed

Changes in file .github/workflows/CI-DOCS.yml:

• changed CI environment and added path filtering
• similar changes for documentation generation in CI/CD
• fixed a few missed values
• related work

Changes in file .github/workflows/CI-MATs.yml:

• updated check_build to fetch the build info file
• added cleanup prototype after fetching build info
• added default token for gh api usage
• added job to comment with summary on relevant commit
• added logic to load the build-info artifact
• added logic to post commit comment with MATs details
• separated status and summary jobs (summaries will be built in new template action)
• various fixes from prototyping
• improved cleanup by moving the artifact into place
• integrated new template GHA to control checks better
• minor refactor to format
• minor refactor for quoting
• related work
• removed debug check for fetched build-info
• separated status and summary jobs (summaries will be built in new template action)
• updated to use new generated summaries and concatenate them

Changes in file .github/workflows/codeql-analysis.yml:

• code-ql version bumps in CI

Changes in file .github/workflows/makefile-lint.yml:

• version bumps for CI
• implemented fix to use new variable configured in GitHub Actions dashboard (undocumented)
• fixes applied for CI

Changes in file .github/workflows/scorecard.yml:

• various version bumps for CI

Changes in file .github/workflows/shellcheck.yml:

• version bump for CI

Changes in file .github/workflows/Tests.yml:

• added initial coverage summary comment job
• improved existing summary reporting for CI/CD tests
• expanded with new summary reporting for CI/CD tests
• implement downloading and loading info from MATs
• added logic to get triggering workflow id
• added random uuid logic for windows edge-case
• codecov/codecov-action version bumps in CI
• ensure extra CI/CD tools are available in CI/CD for testing
• expand env values with trigger artifact info
• updated most jobs to need the check_mats job for build_info values
• various fixes for inputs to use triggering commit
• various fixes for style inconsistencies
• improved output
• refactor for, and integrated, new GHA templates
• improvements from integrating #130
• implemented new job to trigger Coveralls API to signal when reporting completes for a build-id
• integrated and improved check control
• improvements from #403
• related work
• removed deprecated "EXTRAS-FOR-SETUP" from config from PEP-621 support
• resolved conflicts between GHIs #130 and #403

Changes in file .gitignore:

• related work for PEP-621 support

Additions with file .gitmodules:

• added submodule fo...

Alpha 4 Release Candidate for Version 2.0.9

Known flaws.

Warning

This commit has known flaws. Each commit is subject to minimal acceptance testing, and then select commits are subject to extra testing to evaluate release candidates; This Release Candidate has been deemed not ready for release.

Security Pre-Release

• This patch contains an early pre-release for security updates.
  • Fixes GHSA-94v7-wxj6-r2q5

Full Changelog: v2.0.9-dev...v2.0.9a4

Alpha 3 Release Candidate for Version 2.0.9 - YANK

Known flaws.

Warning

This commit has known flaws. Each commit is subject to minimal acceptance testing, and then select commits are subject to extra testing to evaluate release candidates; This Candidate has been deemed not ready for release.

What's Changed

• [FEATURE] Initial implementation of the pipe option (- WIP #216 -) by @reactive-firewall in #392
• [UPDATE] (deps): Bump github/codeql-action from 3.28.16 to 3.28.17 in /.github/workflows by @dependabot in #395
• [UPDATE] (deps): Bump reactive-firewall/shellcheck-scan from 1.1 to 1.2 in /.github/workflows by @dependabot in #396
• [HOTFIX] (deps-dev): Bump markdownlint from 0.37.4 to 0.38.0 in the development-dependencies group by @dependabot in #397
• Round two of CI/CD Improvements by @reactive-firewall in #402
• [HOTFIX] Fix for CI/CD license checks by @reactive-firewall in #404

Full Changelog: v2.0.8...v2.0.9a3

v2.0.8

Release Notes for Version 2.0.8

This release candidate represents the culmination of numerous smaller efforts, bringing together improvements from over 40 previous PRs and addressing over 40 distinct issues. It serves as a comprehensive preparation for future development, establishing strong foundations for the upcoming 2.1 version.

These changes aim to enhance code quality, enforce best practices, and streamline CI/CD processes.

---

Patch Notes

📊 Metrics Summary

• Files Changed: 100 files across 10 directories
• Code Volume: 4,905 lines added, 1,059 lines deleted
• Impact Scope:
  • Core Python Files: 8 files (1,370 lines added, 447 lines deleted)
  • Documentation: 12 files (425 lines added, 145 lines deleted)
  • Configuration: 80 files (3,110+ lines added, ~467 lines deleted)
• Issue Resolution: Closes 44+ distinct issues
• PR Consolidation: Supersedes 42+ previous PRs
• Milestone: Concludes "Pre-Version 2.1 Chores" (milestone/13)

Summary

• New Features

  • Introduced advanced static analysis and linting rules for Python and YAML, including comprehensive docstring, test, and GitHub Actions workflow validation.
  • Added new GitHub Actions workflows for shell script and Makefile linting, Flake8 checks, and enhanced CI/CD for builds, tests, and PyPI deployment.
  • Implemented a robust CI/CD output tool for improved logging and GitHub Actions integration.
  • Added new utility scripts for lock file management and Makefile checks.

• Improvements

  • Enhanced logging, error handling, and type annotations across core modules and test suites.
  • Standardized and expanded configuration files for pytest, coverage, and documentation.
  • Improved code style, string formatting, and exception handling throughout the codebase.
  • Updated Makefile and test infrastructure for greater flexibility, modularity, and cleanup.

• Bug Fixes

  • Fixed quoting, shellcheck, and variable handling in CI scripts and test utilities.
  • Corrected and clarified exception chaining and resource cleanup in code examples and documentation.

• Documentation

  • Extended and reorganized documentation with new badges, configuration instructions, and improved code examples.
  • Improved Sphinx and markdown configuration for better documentation generation and reference linking.

• Chores

  • Updated dependencies and tool versions, including Python, Flake8, markdownlint, and GitHub Actions.
  • Refined labeling, issue, and pull request templates for better workflow management.

• Style

  • Unified string literal usage, code formatting, and naming conventions for consistency and readability.

• Tests

  • Refactored test suite organization, added dynamic doctest loading, and expanded test markers and categories.

🚀 New Features and Enhancements

1. Error Handling Improvements:

   • Refactored exception handling for better traceability and maintainability.
   • Introduced ShutdownCommandReceived exception for explicit shutdown command handling.

2. Documentation and Templates:

   • Expanded CI and environment configuration documentation, including new badges, usage examples, and copyright/license.
   • Improved docstrings, exception guides, and FAQ with clearer examples and error handling.

Testing and Quality Improvements

• Added new tests for Python versions, workflows for minimal acceptance, and doctests.
• Enhanced test suite structure, added dynamic doctest loading, and improved test marker definitions.

1. Static Analysis and Linting:

   • Introduced extensive static analysis and linting rule configurations for Python and YAML, enforcing documentation, naming conventions, code style, and GitHub Actions workflow patterns.
   • Added 20 new AST-grep rules, including 16 multicast-specific, 3 Python-specific, and 1 GHA-specific rules.

2. Enhanced GitHub Actions:

   • New workflows for Flake8, Shellcheck, CD-PyPi, and Makefile Lint.
   • Updates to existing workflows for CI, testing, and code quality checks.
   • Improved automation for packaging, testing, and deployment.

3. Housekeeping and Configuration:

   • Revised .gitignore to exclude more development artifacts.
   • Enhanced Makefile with new targets (branding, purge-coverage-artifacts), dependencies management, and defaults.

🩹 Bug Fixes

• Improved error handling, logging, and validation across core modules (multicast, env, exceptions, recv, hear, send, skt).
• Standardized string literals and exception variable naming for clarity and consistency.

Deprecations and Replacements

• Removed Legacy Scripts: Tools like tool_checkmake.sh and tool_shlock_helper.sh were replaced with symbolic links or moved under .github/tools/.
• Workflow Adjustments: Deprecated YAML configurations were replaced or updated with streamlined and secure alternatives.

Key Changes and Impacts

The changes introduced in the v2.0.8 release (compared to v2.0.7) are extensive and cover multiple areas of the repository.

🗝️ Key Impact Details

1. Error Handling Improvements

• Refactoring Exception Handling:
  • Changed exception variable naming from generic (e.g., err, impErr) to _cause for better traceability.
  • Improved raise from usage to maintain the original exception context.
  • Enhanced clarity and maintainability of error handling across the codebase.

Impact:

• These changes improve debugging and maintainability by providing more informative and granular error contexts. They also align with best practices for exception handling.

2. New Features

• ShutdownCommandReceived Exception:
  • Added a new exception class to handle shutdown commands explicitly.
• AST-Grep Rules for Code Standardization:
  • Introduced .ast-grep rules to enforce patterns for doStep and setupArgs implementations.
  • Added utility files for Python-specific AST validation.

Impact:

• These features enhance robustness by formalizing error handling for shutdown scenarios.
• Enforcing code patterns ensures consistency in the implementation of core functions.

3. Documentation Updates

• Updated exception handling examples in Exception_Guide.md.
• Revised FAQ and usage documentation to reflect changes in error handling and function signatures.
• Incremented version references in docs/conf.py.

Impact:

• Documentation is now more accurate and user-friendly, helping developers understand new conventions and best practices.

4. Testing Enhancements

• Improved Coverage for Doctests:
  • Added configurations to include only multicast/* files in coverage reports for doctests.
• Additional Test Cases:
  • Added tests for edge cases and regression.
• Refinements in Test Utilities:
  • Enhanced logging and output formatting using cioutput.py.

Impact:

• Enhanced test coverage and detailed reporting improve test reliability and debugging efficiency.

5. Build and Deployment

• New PyPI Deployment Workflow:
  • Introduced CD-PyPi.yml workflow for automated publishing of releases to PyPI.
• Updated CI Workflows:
  • Refined CI configurations to align with Python version updates and GitHub Action improvements.

Impact:

• The new deployment pipeline automates release publishing, reducing manual overhead.
• Updated CI workflows leverage the latest tools and methodologies, ensuring compatibility and reliability.

6. Code Style and Linting

• Consistency Improvements:
  • Unified function type annotations for better static analysis.
  • Refactored redundant or deprecated patterns.
• Tooling Updates:
  • Introduced .github/tools/cioutput.py for consistent CI/CD output formatting.
  • Enhanced Makefile with branding and improved task definitions.

Impact:

• These changes enhance code quality, readability, and maintainability.

7. Miscellaneous

• Deprecations:
  • Removed obsolete shell scripts and replaced them with symbolic links or consolidated versions.
• Branding:
  • Added branding to the Makefile for a more professional touch.

Impact:

• Streamlining and branding improve the overall developer experience and project presentation.

Summary

The v2.0.8 release introduces significant improvements in exception handling, testing, build automation, and code quality. These changes enhance robustness, maintainability, and developer productivity.

🧹 Miscellaneous

• Branding: Added branding to the Makefile for a more professional touch.
• Technical Debt Reduction: Refactoring legacy code patterns and standardizing coding practices.

Conclusion

This release candidate represents the culmination of numerous smaller efforts, bringing together improvements from over 40 previous PRs and addressing over 40 distinct issues. It serves as a comprehensive preparation for future development, establishing strong foundations for the upcoming 2.1 version.

🔍 Change Analysis

Core Functionality Enhancements

The PR includes significant improvements to all core modules of the multicast package:

• hear.py: Substantial refactoring (348 additions, 53 deletions)
• env.py: Enhanced environment handling (263 additions, 51 deletions)
• exceptions.py: Improved error handling (189 additions, 50 deletions)
• recv.py: Optimized receiving functionality (183 additions, 54 deletions)
• init.py: Updated package initialization (162 additions, 75 deletions)

Quality & Standards Implementation

A major focus on code quality through:

• **20 ...

v2.0.8a0

What's Changed

• Improved multicast specific ast-grep rules slightly by @reactive-firewall in #379
• [UPDATE] (deps): Bump ossf/scorecard-action from de386ed459e2f85111697f50fe076d0ea617a32f to 18cc9b81307fc5ab3c2cd7092955f06dcfdf8c42 in /.github/workflows by @dependabot in #381
• [UPDATE] (deps): Bump github/codeql-action from 3.28.15 to 3.28.16 in /.github/workflows by @dependabot in #382
• [UPDATE] (deps): Bump actions/setup-python from 5.5.0 to 5.6.0 in /.github/workflows by @dependabot in #383
• Feature ci tool 265 by @reactive-firewall in #384
• Patch error style by @reactive-firewall in #385
• Add pragma coverage annotations to MulticastUDPClient.py and run_selective.py by @reactive-firewall in #388
• Stage Version 2.0.8-alpha by @reactive-firewall in #389

Full Changelog: v2.0.7...v2.0.8-alpha