Skip to content

feat: Initial release#1

Merged
abaczek merged 1 commit into
mainfrom
first_release
Jul 11, 2025
Merged

feat: Initial release#1
abaczek merged 1 commit into
mainfrom
first_release

Conversation

@abaczek

@abaczek abaczek commented Jul 11, 2025

Copy link
Copy Markdown
Contributor

This pull request introduces several new workflows, updates documentation, and adds example scripts for the MFD Ping project. 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 .whl packages 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 via workflow_dispatch, leveraging the reusable build_upload_whl.yml workflow for release builds.
  • .github/workflows/pull_requests.yml: Implements a workflow for pull requests that builds .whl packages for development purposes using the reusable build_upload_whl.yml workflow.
  • .github/workflows/codeql.yml: Adds a CodeQL workflow for advanced code analysis on the main branch and pull requests, supporting Python and GitHub Actions languages.

Documentation updates:

  • README.md: Provides detailed information about the MFD Ping module, 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:

@mfd-intel-bot

Copy link
Copy Markdown

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-ping@first_release'

1 similar comment
@mfd-intel-bot

Copy link
Copy Markdown

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-ping@first_release'

@github-advanced-security

Copy link
Copy Markdown

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.

Comment thread .github/workflows/manual_release.yml Dismissed
Comment thread .github/workflows/pull_requests.yml Dismissed
@hcymerys hcymerys requested a review from Copilot July 11, 2025 14:17

This comment was marked as outdated.

Signed-off-by: Baczek, Arkadiusz <arkadiusz.baczek@intel.com>
@mfd-intel-bot

Copy link
Copy Markdown

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-ping@first_release'

@mchromin mchromin requested a review from Copilot July 11, 2025 14:32
@mfd-intel-bot

Copy link
Copy Markdown

We don't publish DEVs .whl.
To build .whl, run 'pip install git+https://github.com/intel/mfd-ping@first_release'

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 frag says 'Enable fragmentation', but code treats frag=False as 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:

Comment thread mfd_ping/traffics/client_traffic.py
Comment thread mfd_ping/base.py
Comment thread mfd_ping/windows.py
@abaczek abaczek merged commit 63dc8e9 into main Jul 11, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants