v2.0.9a6
Pre-releaseWhat 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 file docs/requirements.txt:
- updated license urls
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
- add documentaion dep sphinxcontrib-mermaid (MIT/BSD like license)
Changes in file tests/check_spelling:
- updated regressions list
Changes in file tests/context.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/init.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/MulticastUDPClient.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/profiling.py:
- updated license url
Changes in file tests/requirements.txt:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/run_selective.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_basic.py:
- updated license url
Changes in file tests/test_build.py:
- updated license url
Changes in file tests/test_deps.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_exceptions.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_extra.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_fuzz.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_hear_cleanup.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_hear_data_processing.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_hear_keyboard_interrupt.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_hear_server_activate.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_hear_server.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_manifest.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_recv.py:
- updated license url
- refactored "reactive-firewall/multicast" to "reactive-firewall-org/multicast"
Changes in file tests/test_usage.py:
- updated license url
Full Changelog: v2.0.9a6...v2.0.9a5