Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace deprecated classifier with licence expression (PEP 639) #110

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

shenxianpeng
Copy link
Collaborator

@shenxianpeng shenxianpeng commented Feb 20, 2025

Same as cpp-linter/cpp-linter#136

Summary by CodeRabbit

  • Chores
    • Updated the project’s licensing metadata by simplifying the license declaration.
    • Specified the location of the license file for improved clarity.

@shenxianpeng shenxianpeng added the enhancement New feature or request label Feb 20, 2025
Copy link

coderabbitai bot commented Feb 20, 2025

Walkthrough

This pull request updates the project metadata in the pyproject.toml file. The license declaration has been modified from a table format to a string format, changing from license = {text = "MIT License"} to license = "MIT". Additionally, a new entry license-files = [ "LICENSE" ] has been added to indicate the location of the license file. All other metadata configurations remain unchanged.

Changes

File Change Summary
pyproject.toml Updated license declaration from a table format to a string format; added license-files to specify file location

Suggested labels

documentation

Poem

I'm a rabbit hopping through config delight,
Tweaking licenses by day and by night.
From tables to strings, the change is neat,
Adding license files makes it complete.
With a hop, a skip, and a joyful bounce,
I celebrate updates — let the changes announce!
🐇💻


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 86af63a and 9c1bbe8.

📒 Files selected for processing (1)
  • pyproject.toml (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Test
pyproject.toml

[error] 1-1: invalid pyproject.toml config: project.license. configuration error: project.license must be valid exactly by one definition (2 matches found): - keys: 'file': {type: string} required: ['file'] - keys: 'text': {type: string} required: ['text']

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Codacy Static Code Analysis

Comment on lines +10 to +11
license = "MIT"
license-files = [ "LICENSE" ]
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

⚠️ Potential issue

Critical Issue: Invalid project.license Format Causing Schema Validation Error

The new change sets the license as a bare string (license = "MIT"). However, the pipeline error indicates that the schema expects the project.license field to be unambiguously defined as a table—with either a "text" key or a "file" key—not as a plain string. To resolve this conflict, please update the license declaration to a table format. For example, the diff below would address the issue:

-license = "MIT"
+license = { text = "MIT" }

The accompanying license-files entry (line 11) is acceptable if you intend to signal where the license file is located.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
license = "MIT"
license-files = [ "LICENSE" ]
license = { text = "MIT" }
license-files = [ "LICENSE" ]

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant