ci: Support pydantic 2.7 and sphinx 7.3

mansenfranzen commented 7 months ago

Type

enhancement, configuration changes

Description

Added support for Sphinx version 7.3 in GitHub Actions CI, tox environments, and updated the test matrix accordingly.
Introduced defusedxml as a new optional dependency in pyproject.toml and included it in the 'test' extras.

Changes walkthrough

Relevant files

Configuration changes

tests.yml `Update Sphinx version in GitHub Actions CI` .github/workflows/tests.yml - Updated Sphinx version to 7.3 for Python 3.12 in CI test matrix.	+1/-1
tox.ini `Support Sphinx 7.3 in tox environments` tox.ini Updated the `envlist` to include Sphinx 7.3. Added Sphinx 7.3 to the dependencies in the test environments.	+3/-2

Enhancement

pyproject.toml

Add defusedxml to optional dependencies and test extras

pyproject.toml

Added defusedxml as an optional dependency.

Included defusedxml in the 'test' extras section.

+3/-1

✨ PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

github-actions[bot] commented 7 months ago

PR Description updated to latest commit (https://github.com/mansenfranzen/autodoc_pydantic/commit/11737b1e23102ef29758780562e1e4f62e6f0aa4)

github-actions[bot] commented 7 months ago

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and involve version updates and dependency additions, which are generally easy to verify and do not require deep code logic understanding.
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

Code feedback:

✨ Review tool usage guide:

**Overview:** The `review` tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be [added](https://pr-agent-docs.codium.ai/tools/review/#general-configurations) by configuring the tool. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on any PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L23) related to the review tool (`pr_reviewer` section), use the following template: ``` /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_reviewer] some_config1=... some_config2=... ``` See the review [usage page](https://pr-agent-docs.codium.ai/tools/review/) for a comprehensive guide on using this tool.

github-actions[bot] commented 7 months ago

PR Code Suggestions

Category	Suggestions
Best practice	Standardize version number formatting in the workflow file. ___ Update the `sphinx_version` to use a string format consistent with other version specifications in the workflow file. [.github/workflows/tests.yml [52]](https://github.com/mansenfranzen/autodoc_pydantic/pull/261/files#diff-1db27d93186e46d3b441ece35801b244db8ee144ff1405ca27a163bfe878957fR52-R52) ```diff -sphinx_version: "73" +sphinx_version: "7.3" ```
Best practice	Ensure compatibility and prevent potential future breaking changes by specifying a safer version range. ___ Add a version range for `defusedxml` to ensure compatibility with future releases without breaking changes. [pyproject.toml [43]](https://github.com/mansenfranzen/autodoc_pydantic/pull/261/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R43-R43) ```diff -defusedxml = { version = ">=0.7.1", optional = true } +defusedxml = { version = "^0.7.1", optional = true } ```

✨ Improve tool usage guide:

**Overview:** The `improve` tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered [automatically](https://pr-agent-docs.codium.ai/usage-guide/automations_and_usage/#github-app-automatic-tools-when-a-new-pr-is-opened) every time a new PR is opened, or can be invoked manually by commenting on a PR. - When commenting, to edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/configuration.toml#L78) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` - With a [configuration file](https://pr-agent-docs.codium.ai/usage-guide/configuration_options/), use the following template: ``` [pr_code_suggestions] some_config1=... some_config2=... ``` See the improve [usage page](https://pr-agent-docs.codium.ai/tools/improve/) for a comprehensive guide on using this tool.

mansenfranzen / autodoc_pydantic