Skip to content

License cleanup patch #438

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

Merged
merged 1 commit into from
Jun 10, 2025
Merged

Conversation

reactive-firewall
Copy link
Collaborator

@reactive-firewall reactive-firewall commented Jun 10, 2025

Patch Notes

Updated a few more License URLs to direct links.

Impacted GHI

Included and Superseded PR/MRs

Changes by file in this patch

Changes in file LICENSE.md:

  • updated a few more licences to direct links

Changes in file tests/profiling.py:

  • updated python-repo licences to direct link

Changes in file tests/test_basic.py:

  • updated python-repo licences to direct link

Changes in file tests/test_build.py:

  • updated python-repo licences to direct link

Changes in file tests/test_usage.py:

  • updated python-repo licences to direct link

Summary by CodeRabbit

  • Documentation
    • Updated license reference URLs in documentation and file headers to point to the latest version on the default branch. No functional changes were made.

Changes in file LICENSE.md:
 * updated a few more licences to direct links

Changes in file tests/profiling.py:
 * updated python-repo licences to direct link

Changes in file tests/test_basic.py:
 * updated python-repo licences to direct link

Changes in file tests/test_build.py:
 * updated python-repo licences to direct link

Changes in file tests/test_usage.py:
 * updated python-repo licences to direct link
@reactive-firewall reactive-firewall self-assigned this Jun 10, 2025
@reactive-firewall reactive-firewall added documentation Improvements or additions to documentation Chore Miscellaneous chores to maintain the project labels Jun 10, 2025
@reactive-firewall reactive-firewall linked an issue Jun 10, 2025 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Jun 10, 2025

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between a6e9bea and c51733c.

📒 Files selected for processing (5)
  • LICENSE.md (2 hunks)
  • tests/profiling.py (1 hunks)
  • tests/test_basic.py (1 hunks)
  • tests/test_build.py (1 hunks)
  • tests/test_usage.py (1 hunks)
 _______________________________________________________
< Perhaps loot boxes can help us cover the OpenAI bill. >
 -------------------------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
✨ Finishing Touches
  • 📝 Generate Docstrings

🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @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.

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.

@github-actions github-actions bot added Multicast Any main project file changes Python Lang Changes to Python source code Testing Something can be verified CI Continuous Integration Tooling labels Jun 10, 2025
Copy link

deepsource-io bot commented Jun 10, 2025

Here's the code health analysis summary for commits a6e9bea..c51733c. View details on DeepSource ↗.

Analysis Summary

AnalyzerStatusSummaryLink
DeepSource Python LogoPython✅ SuccessView Check ↗
DeepSource Test coverage LogoTest coverage✅ SuccessView Check ↗

Code Coverage Report

MetricAggregatePython
Branch Coverage92.4%92.4%
Composite Coverage96.5%96.5%
Line Coverage96.8%96.8%

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

Copy link

codecov bot commented Jun 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

Copy link
Collaborator Author

@reactive-firewall reactive-firewall left a comment

Choose a reason for hiding this comment

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

👍 LGTM;

Note

with caveat: I am the project owner/admin and was this PR's author and I self-reviewed.

@reactive-firewall reactive-firewall moved this from To do to In progress in Multicast Project Jun 10, 2025
@github-project-automation github-project-automation bot moved this from In progress to Resolved in Multicast Project Jun 10, 2025
Copy link
Contributor

@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.yaml
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6e9bea and c51733c.

📒 Files selected for processing (5)
  • LICENSE.md (2 hunks)
  • tests/profiling.py (1 hunks)
  • tests/test_basic.py (1 hunks)
  • tests/test_build.py (1 hunks)
  • tests/test_usage.py (1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`**/*.py`: When reviewing **Python** code for this project: 1. Prioritize portability over clarity, especially when dealing with cross-Python compatibility. However, with the pr...

**/*.py: When reviewing Python code for this project: 1. Prioritize portability over clarity, especially when dealing with cross-Python
compatibility. However, with the priority in mind, do still consider improvements to
clarity when relevant.
2. As a general guideline, consider the code style advocated in the PEP 8 standard
(excluding the use of spaces for indentation) and evaluate suggested changes for code
style compliance.
3. As a style convention, consider the code style advocated in
CEP-8
and evaluate suggested changes for code style compliance.
4. As a general guideline, try to provide any relevant, official, and supporting
documentation links to any tool's suggestions in review comments. This guideline is
important for posterity.
5. As a general rule, undocumented function definitions and class definitions in the
project's Python code are assumed incomplete. Please consider suggesting a short
summary of the code for any of these incomplete definitions as docstrings when
reviewing. All documentation including docstrings in the project are to align with
the guidelines set by
CEP-7.
6. Verify Flake8's configuration file is located at ".flake8.ini". Flake8 is run
automaticly by the flake8-cq GHA used by the .github/workflows/flake8.yml workflow.
7. Verify alignment of any new changes, with the code style advocated in
CEP-8,
pointing out any introduced deviations.

  • tests/test_build.py
  • tests/profiling.py
  • tests/test_usage.py
  • tests/test_basic.py
`tests/*`: When reviewing **test** code: 1. Prioritize portability over clarity, especially when dealing with cross-Python compatibility. However, with the priority in mind, do ...

tests/*: When reviewing test code: 1. Prioritize portability over clarity, especially when dealing with cross-Python
compatibility. However, with the priority in mind, do still consider improvements
to clarity when relevant.
2. As a general guideline, consider the code style advocated in the PEP 8 standard
(excluding the use of spaces for indentation) and evaluate suggested changes
for code style compliance.
3. As a style convention, consider the code style advocated in
CEP-8
and evaluate suggested changes for code style compliance, pointing out any
violations discovered.
4. As a style convention, consider the code style advocated in
CEP-9
and evaluate suggested changes for nomenclature compliance, pointing out any
violations discovered, along with suggestions generated to correct the nomenclature.
5. As a general guideline, try to provide any relevant, official, and supporting
documentation links to any tool's suggestions in review comments. This guideline is
important for posterity.
6. As a project rule, Python source files with names prefixed by the string
"test_" and located in the project's "tests" directory are the project's unit-testing
code. It is safe, albeit a heuristic, to assume these are considered part of the
project's minimal acceptance testing unless a justifying exception to this assumption
is documented.
7. As a project rule, any files without extensions and with names prefixed by either the
string "check_" or the string "test_", and located in the project's "tests" directory,
are the project's non-unit test code. "Non-unit test" in this context refers to any
type of testing other than unit testing, such as (but not limited to)
functional testing, style linting, regression testing, etc. It can also be assumed
that non-unit testing code is usually (but not always) written as Bash shell scripts.

  • tests/test_build.py
  • tests/profiling.py
  • tests/test_usage.py
  • tests/test_basic.py
🧠 Learnings (1)
📓 Common learnings
Learnt from: reactive-firewall
PR: reactive-firewall-org/multicast#433
File: generate_changelog.sh:153-158
Timestamp: 2025-06-09T05:51:10.677Z
Learning: reactive-firewall prefers readability over micro-optimizations in shell scripts, such as keeping `cat` usage even when direct file reading would be more efficient, because it makes the code more explicit and readable.
Learnt from: reactive-firewall
PR: reactive-firewall-org/multicast#433
File: generate_changelog.sh:243-257
Timestamp: 2025-06-09T05:01:35.254Z
Learning: The user reactive-firewall prefers to implement code changes manually rather than using automated code change features, following their organization's AI Usage Policy which requires human oversight and control over code modifications.
🔇 Additional comments (5)
LICENSE.md (1)

70-70: External repo URL update is correct

The YMMV repository’s LICENSE.md link now explicitly points to the HEAD branch and is consistent with other license references in this file.

tests/test_build.py (1)

12-12: License URL updated correctly to reference HEAD branch

The comment now points to https://github.com/reactive-firewall/python-repo/blob/HEAD/LICENSE.md, aligning with other test files.

tests/test_usage.py (1)

12-12: License URL updated correctly

The URL now references the HEAD branch for the LICENSE.md file, consistent with other test modules.

tests/profiling.py (1)

12-12: License URL updated correctly

The comment now points to the HEAD branch of the license, matching the pattern in other test files.

tests/test_basic.py (1)

12-12: License URL updated correctly

The license reference in the header now explicitly links to blob/HEAD/LICENSE.md, consistent with repository standards.

@github-project-automation github-project-automation bot moved this from Resolved to Regressions in Multicast Project Jun 10, 2025
@github-project-automation github-project-automation bot moved this from Regressions to Resolved in Multicast Project Jun 10, 2025
@reactive-firewall reactive-firewall merged commit 794f02f into master Jun 10, 2025
45 checks passed
@github-project-automation github-project-automation bot moved this from Resolved to Done in Multicast Project Jun 10, 2025
@reactive-firewall reactive-firewall deleted the patch-cleanup-licenses-335 branch June 10, 2025 21:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Chore Miscellaneous chores to maintain the project CI Continuous Integration Tooling documentation Improvements or additions to documentation Multicast Any main project file changes Python Lang Changes to Python source code Testing Something can be verified
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

HOTFIX new org URL for Repo in CI/CD v2.1.x Chore - Update license URLs to direct raw content links v2.1.x Chore - Update license URLs
1 participant