Skip to content

Conversation

bernhardkaindl
Copy link
Contributor

Cumulative PR: Update docs, fix CI failures and add checking pre-commit in CI

This PR contains 7 commits that are ready for merge now.

The first commit is necessary to resolve CI issues, and the subsequent six PRs will incorporate individual commits on top of this initial commit to address type analysis and documentation problems.

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR updates documentation and fixes CI issues by consolidating 7 commits that address type analysis problems, improve documentation formatting, and add pre-commit checking to CI workflows.

  • Updates documentation formatting from old-style comments to proper markdown and docstring formats
  • Fixes CI configuration by adjusting coverage thresholds and excluding problematic files
  • Adds pre-commit checking as a CI job to catch formatting and style issues early

Reviewed Changes

Copilot reviewed 8 out of 12 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
xcp/net/ifrename/static.py Updates documentation formatting from plain text to markdown bullet points and corrects technical acronym capitalization
xcp/net/ifrename/logic.py Modernizes function documentation from old @param style to proper docstring format with Parameters/Returns/Raises sections
tox.ini Adjusts test coverage thresholds and removes exclusion for specific file from diff-cover
stubs/pytest_httpserver.pyi Complete removal of type stub file (134 lines deleted)
docs/source/conf.py Adds explicit type annotation to exclude_patterns variable
README-Unicode.md Fixes spelling errors and improves markdown formatting with proper code block language identifiers
.pre-commit-config.yaml Adds exclusions for documentation files to prevent pre-commit hook conflicts
.github/workflows/main.yml Adds new pre-commit CI job to validate code formatting and style

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@bernhardkaindl bernhardkaindl force-pushed the CI-and-docs-add-xcp.net-classes-to-Sphinx-docsite branch 2 times, most recently from 14c811a to 701c312 Compare September 22, 2025 23:50
Copilot

This comment was marked as outdated.

Copy link

codecov bot commented Sep 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@          Coverage Diff           @@
##           master    #176   +/-   ##
======================================
  Coverage    83.3%   83.3%           
======================================
  Files          23      23           
  Lines        3347    3347           
======================================
  Hits         2790    2790           
  Misses        557     557           

@bernhardkaindl bernhardkaindl force-pushed the CI-and-docs-add-xcp.net-classes-to-Sphinx-docsite branch 2 times, most recently from 3184248 to 8d1f365 Compare September 23, 2025 11:10
Copilot

This comment was marked as resolved.

@bernhardkaindl bernhardkaindl force-pushed the CI-and-docs-add-xcp.net-classes-to-Sphinx-docsite branch 2 times, most recently from 81b2bb4 to 4d50439 Compare September 26, 2025 13:01
@bernhardkaindl bernhardkaindl force-pushed the CI-and-docs-add-xcp.net-classes-to-Sphinx-docsite branch from 4d50439 to 42f2689 Compare September 26, 2025 13:10
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

Copilot reviewed 4 out of 8 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@bernhardkaindl bernhardkaindl changed the title Cumulative PR: Update docs, fix CI failures and add checking pre-commit in CI Fix final markdownlint errors and add running pre-commit in CI Sep 26, 2025
@bernhardkaindl bernhardkaindl merged commit 75054b3 into xenserver:master Sep 26, 2025
9 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.

1 participant