ci: Support pydantic 2.7 and sphinx 7.3

mansenfranzen commented 7 months ago

User description

ci: Add defusedxml as optional test dependency which was previously implicitly included by other deps.

Type

enhancement, tests

Description

Added support for Sphinx 7.3 in CI workflows, tox.ini configurations, and testing dependencies.
Introduced defusedxml as a new optional test dependency in pyproject.toml and updated the test extras list to include it.

Changes walkthrough

Relevant files

Configuration changes

tests.yml `Update Sphinx Version in GitHub Actions CI` .github/workflows/tests.yml - Updated the Sphinx version to 7.3 for Python 3.12 in CI workflows.	+1/-1
tox.ini `Extend Test Environments to Include Sphinx 7.3` tox.ini Extended the test environments to include Sphinx version 7.3. Added Sphinx 7.3 to the dependencies list for specific test environments.	+3/-2

Dependencies

pyproject.toml

Add `defusedxml` Dependency for Testing

pyproject.toml

Added defusedxml as an optional test dependency.

Included defusedxml in the test extras list.

+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 limited to version updates and the addition of a dependency across a few configuration files.
🧪 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	Ensure version number formatting consistency. ___ Ensure that the version numbers for `sphinx_version` and `pydantic_version` are formatted consistently with the other version specifications in the file. Use double quotes for consistency. [.github/workflows/tests.yml [52]](https://github.com/mansenfranzen/autodoc_pydantic/pull/260/files#diff-1db27d93186e46d3b441ece35801b244db8ee144ff1405ca27a163bfe878957fR52-R52) ```diff -sphinx_version: "73" +sphinx_version: "7.3" ```
Best practice	Improve formatting consistency in dependency version specification. ___ Add a space around the equals sign for the `defusedxml` version to maintain consistency with the formatting of other dependencies in the file. [pyproject.toml [43]](https://github.com/mansenfranzen/autodoc_pydantic/pull/260/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R43-R43) ```diff -defusedxml = { version = ">=0.7.1", optional = true } +defusedxml = { version = ">= 0.7.1", optional = true } ```
Bug	Update the `pydantic_version` to reflect the correct version support. ___ The version number for `pydantic_version` should be updated to match the new support for version 2.7, as indicated in the PR title. [.github/workflows/tests.yml [51]](https://github.com/mansenfranzen/autodoc_pydantic/pull/260/files#diff-1db27d93186e46d3b441ece35801b244db8ee144ff1405ca27a163bfe878957fR51-R51) ```diff -pydantic_version: "27" +pydantic_version: "2.7" ```

✨ 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