v2.0.9a5
Pre-releaseAlpha 5 for Version 2.0.9 (v2.0.9a5) Patch Notes
Impacted GHI
- Closed #130
- Closed #417
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.9series - 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.pyto "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 apiusage - 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 apiusage - 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 for implementing GHI #130
Changes in file LICENSE.md:
- improved with advisory for readability (e.g., dependencies not included)
- minor changes to style
- related work for PEP-621 support
Changes in file Logo.svg:
- added missing commas
Changes in file Makefile:
- attempt to make build target less pre-emptive
- improved many test categories to generate additional coverage reports
- reworked build logic to avoid any need to call setup.py
- related work
Changes in file multicast/init.py:
- bumped version to
2.0.9series - Added note that some dunder can be ignored by users
- Added trivial doctests to some dunder
- refactored to use cli() instead of main() as entry point
- other minor fixes for doctests
- other minor improvements to documentation
- related work (added missing commas)
Changes in file multicast/main.py:
- ✨ implemented a new entry-point cli() function
- some opportunistic refactoring
- related work (added missing commas)
Changes in file multicast/send.py:
- use a group for related arguments
- ✨ added experimental new
--pipeflag as part of GHI #216
Changes in file package.json:
- version bump for markdown-linter in CI
Changes in file pyproject.toml:
- refactored for PEP-621
- switched to use cli function as entry-point
- bumped version to
2.0.9series
Changes in file pytest.ini:
- related work
Changes in file README.md:
- added MATs badge
- some rewording for readability
- minor style changes
- switched License badge to fix label
- updated install instructions
Changes in file requirements.txt:
- remove some duplicates
- version bumps
Changes in file docs/requirements.txt:
- added notes about various licenses
- remove duplicates
- version bumps
- related comments
Changes in file setup.cfg:
- bumped version to
2.0.9series
Deletions from file setup.cfg:
- related work for PEP-621 support
Deletions from file setup.py:
- removed for PEP-621 support
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
Changes in file .deepsource.toml:
- removed setup.py from dependency sources
Changes in file Makefile:
- improved many test categories to generate additional coverage reports
- reworked build logic to avoid any need to call setup.py
Changes in file tests/check_codecov:
- refactored a bit to focus on config validation more.
- related work
Changes in file tests/check_integration_coverage:
- add more comments
- fixed typo
- expanded tests related to GHI #216
- minor performance improvement from removed delay logic
Deletions from file tests/check_legacy_setup_coverage:
- removed for PEP-621 support
Changes in file tests/check_pip:
- add possible alternative apache-2 license label to allowed list
- followup improvements related to fixing GHI #400
- implement handling traversing git directories and venv
- refactor cioutput usage to hopefully handle venv stuff
- refactor some ignore options
- added more ways to allow public domain dependencies
- ignore "UNKNOWN" result for BSD packages
- added workaround to fix GHI #401 for testing dependency
Changes in file tests/check_spelling:
- updates to ensure that some typos do not happen again
Changes in file tests/init.py:
- changed behavior of doctest loading verbose logging (now less verbose)
- integrated new build tests for PEP-621 support
- optionally plugin new tests implemented in v2.0.7 (test_recv and test_extra)
Changes in file tests/requirements.txt:
- added notes about various licenses
- removed some duplicates
- version bumps
- related comments
Changes in file tests/test_build.py:
- added new PEP-621 test
- related work
Changes in file tests/test_deps.py:
- dropped darwin
venvbuild test support for now, due to venv versus virtualenv differences
Changes in file tests/test_fuzz.py:
- improved wording for onlyIfHasHypothesis docstring
Deletions from file tests/test_install_requires.py:
- removed for PEP-621 support
Changes in file tests/test_manifest.py:
- updated in v2.0.9a3 for PEP-621 regression check
- removed setup step now obsolete by PEP-621 support
- minor refactoring to use f-strings
Full Changelog: v2.0.8...v2.0.9a5