feat: Initial release#1
Conversation
|
We don't publish DEVs .whl. |
1 similar comment
|
We don't publish DEVs .whl. |
|
This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation. |
Signed-off-by: Baczek, Arkadiusz <arkadiusz.baczek@intel.com>
|
We don't publish DEVs .whl. |
|
We don't publish DEVs .whl. |
There was a problem hiding this comment.
Pull Request Overview
Initial release of the MFD Ping module, adding CI/CD workflows, documentation, and example scripts, plus comprehensive unit tests and multi-OS ping implementations.
- Introduces reusable GitHub Actions workflows for building, testing, and releasing Python wheels, plus CodeQL scanning.
- Adds multi-platform ping logic (
WindowsPing,LinuxPing,FreeBSDPing,EsxiPing,MellanoxPing) with unit tests covering argument preparation and output parsing. - Provides Sphinx-based documentation setup, examples for local and SSH-based use, and traffic manager integration.
Reviewed Changes
Copilot reviewed 44 out of 47 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| .github/workflows/build_upload_whl.yml | Adds reusable CI workflow for building and publishing .whl packages |
| mfd_ping/windows.py | Implements Windows-specific ping logic and output parsing |
| tests/unit/test_mfd_ping/test_windows.py | Adds unit tests for WindowsPing behaviors |
Comments suppressed due to low confidence (2)
mfd_ping/traffics/server_traffic.py:16
- No unit tests cover PingServerTraffic; consider adding tests for start, stop, run, and validate methods to ensure expected behavior.
class PingServerTraffic(Traffic):
mfd_ping/windows.py:121
- [nitpick] The docstring for
fragsays 'Enable fragmentation', but code treatsfrag=Falseas adding the '-f' (no-fragment) flag. Clarify the parameter description to indicate it controls the 'do not fragment' option (e.g.,no_frag: bool) or invert the flag logic accordingly.
if frag is False:
This pull request introduces several new workflows, updates documentation, and adds example scripts for the
MFD Pingproject. The primary focus is on automating builds, releases, and code analysis, while also providing comprehensive documentation and usage examples for the module.New workflows for CI/CD and code analysis:
.github/workflows/build_upload_whl.yml: Adds a reusable workflow for building and optionally uploading Python.whlpackages to PyPI. Includes steps for version bumping, unit and functional test execution, and publishing packages..github/workflows/manual_release.yml: Introduces a manual release workflow triggered viaworkflow_dispatch, leveraging the reusablebuild_upload_whl.ymlworkflow for release builds..github/workflows/pull_requests.yml: Implements a workflow for pull requests that builds.whlpackages for development purposes using the reusablebuild_upload_whl.ymlworkflow..github/workflows/codeql.yml: Adds a CodeQL workflow for advanced code analysis on themainbranch and pull requests, supporting Python and GitHub Actions languages.Documentation updates:
README.md: Provides detailed information about theMFD Pingmodule, its usage, API, supported OSes, and integration with Traffic Manager. Includes installation instructions for ESXi users.AUTHORS.md: Lists contributors to the project.CONTRIBUTING.md: Updates project name and license reference.LICENSE.md: Adds the MIT license for the project.Example scripts:
examples/simple_example.py: Demonstrates basic usage of theMFD Pingmodule with a local connection.examples/mellanox_example.py: Provides an example of using theMFD Pingmodule with an interactive SSH connection for Mellanox switches.