Skip to content

snapm: fix report field definition for snapshot_origin#449

Merged
bmr-cymru merged 1 commit intomainfrom
bmr-fix-snapshot-origin-report-field
Aug 29, 2025
Merged

snapm: fix report field definition for snapshot_origin#449
bmr-cymru merged 1 commit intomainfrom
bmr-fix-snapshot-origin-report-field

Conversation

@bmr-cymru
Copy link
Copy Markdown
Contributor

@bmr-cymru bmr-cymru commented Aug 29, 2025

SNAPSHOT_UUID was used as the field description: it should be the header, and the description should be "Snapshot origin".

Resolves: #448

Summary by CodeRabbit

  • Style
    • Updated the label in snapshot reports from “Origin” to “Snapshot origin” for clearer context in PR snapshot displays.
    • Improves readability and reduces ambiguity when interpreting where a snapshot comes from.
    • Visual-only change; no impact on functionality or workflows.

SNAPSHOT_UUID was used as the field description: it should be the
header, and the description should be "Snapshot origin".

Resolves: #448

Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
@bmr-cymru bmr-cymru self-assigned this Aug 29, 2025
@bmr-cymru bmr-cymru added the Bug Something isn't working label Aug 29, 2025
@bmr-cymru bmr-cymru added the UI/UX User interface and experience label Aug 29, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Aug 29, 2025

Walkthrough

The label for the snapshot origin field in snapm/command.py was updated from "Origin" to "Snapshot origin" within the PR_SNAPSHOT entry of _snapshot_fields. No other logic, data structures, or exports were modified.

Changes

Cohort / File(s) Summary of Changes
Snapshot field label update
`snapm/command.py`
Updated human-readable label from "Origin" to "Snapshot origin" in the PR_SNAPSHOT field within _snapshot_fields.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Assessment against linked issues

Objective Addressed Explanation
Correct FieldType argument order for snapshot origin field so description displays accurately (#448) Only label text changed; no evidence of FieldType argument reordering.
Ensure field description reflects snapshot origin purpose and format (#448) Underlying description logic unchanged; label update alone does not fix incorrect metadata.

Poem

I nibble docs with careful sight,
Renamed a tag to read more right—
Yet fields still hop the wrong array,
Their arguments in disarray.
I thump my paw: “Fix order, then
the origin’s truth will shine again!” 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch bmr-fix-snapshot-origin-report-field

🪧 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.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbit in a new review comment at the desired location with your query.
  • PR comments: Tag @coderabbit 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:
    • @coderabbit gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbit read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbit help to get the list of available commands.

Other keywords and placeholders

  • Add @coderabbit ignore or @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbit summary or @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbit or @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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@packit-as-a-service
Copy link
Copy Markdown

Congratulations! One of the builds has completed. 🍾

You can install the built RPMs by following these steps:

  • sudo yum install -y dnf-plugins-core on RHEL 8
  • sudo dnf install -y dnf-plugins-core on Fedora
  • dnf copr enable packit/snapshotmanager-snapm-449
  • And now you can install the packages.

Please note that the RPMs should be used only in a testing environment.

Copy link
Copy Markdown

@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: 0

🧹 Nitpick comments (1)
snapm/command.py (1)

290-297: Optional: add a small regression test for field metadata.

To prevent future arg-order regressions, add a unit test that locates the PR_SNAPSHOT/"origin" FieldType and asserts header == SNAPSHOT_ORIGIN and description == "Snapshot origin".

Happy to draft the test if you want it in this PR.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

💡 Knowledge Base configuration:

  • MCP integration is disabled by default for public repositories
  • Jira integration is disabled by default for public repositories
  • Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between c41db27 and 932f679.

📒 Files selected for processing (1)
  • snapm/command.py (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (39)
  • GitHub Check: rpm-build:fedora-41-x86_64
  • GitHub Check: rpm-build:centos-stream-9-x86_64
  • GitHub Check: rpm-build:fedora-rawhide-x86_64
  • GitHub Check: rpm-build:centos-stream-10-x86_64
  • GitHub Check: rpm-build:fedora-42-x86_64
  • GitHub Check: rpm-build:fedora-43-x86_64
  • GitHub Check: rpm-build:epel-9-x86_64
  • GitHub Check: rpm-build:fedora-41-x86_64
  • GitHub Check: rpm-build:centos-stream-9-x86_64
  • GitHub Check: rpm-build:fedora-rawhide-x86_64
  • GitHub Check: rpm-build:centos-stream-10-x86_64
  • GitHub Check: rpm-build:fedora-42-x86_64
  • GitHub Check: rpm-build:fedora-43-x86_64
  • GitHub Check: rpm-build:fedora-rawhide-x86_64
  • GitHub Check: rpm-build:epel-9-x86_64
  • GitHub Check: rpm-build:centos-stream-9-x86_64
  • GitHub Check: rpm-build:fedora-43-x86_64
  • GitHub Check: rpm-build:fedora-41-x86_64
  • GitHub Check: rpm-build:centos-stream-10-x86_64
  • GitHub Check: rpm-build:fedora-42-x86_64
  • GitHub Check: virt_tests (uefi, lvm, fedora41)
  • GitHub Check: virt_tests (uefi, lvm-thin, centos-stream10)
  • GitHub Check: virt_tests (uefi, lvm, centos-stream10)
  • GitHub Check: virt_tests (bios, lvm, centos-stream10)
  • GitHub Check: virt_tests (bios, lvm, centos-stream9)
  • GitHub Check: virt_tests (uefi, lvm-thin, centos-stream9)
  • GitHub Check: virt_tests (bios, lvm-thin, centos-stream9)
  • GitHub Check: virt_tests (bios, lvm, fedora42)
  • GitHub Check: virt_tests (uefi, lvm-thin, fedora42)
  • GitHub Check: virt_tests (uefi, lvm, centos-stream9)
  • GitHub Check: virt_tests (bios, lvm, fedora41)
  • GitHub Check: virt_tests (uefi, lvm-thin, fedora41)
  • GitHub Check: virt_tests (bios, lvm-thin, centos-stream10)
  • GitHub Check: virt_tests (bios, lvm-thin, fedora41)
  • GitHub Check: virt_tests (uefi, lvm, fedora42)
  • GitHub Check: virt_tests (bios, lvm-thin, fedora42)
  • GitHub Check: Analyze (python)
  • GitHub Check: Analyze (actions)
  • GitHub Check: python-basic-tests
🔇 Additional comments (1)
snapm/command.py (1)

290-297: Fix correct: snapshot origin field now has the right description.

The FieldType tuple for PR_SNAPSHOT/"origin" now uses SNAPSHOT_ORIGIN as the header and "Snapshot origin" as the description, matching the convention used for other fields and addressing #448. Looks good.

@bmr-cymru bmr-cymru merged commit 932f679 into main Aug 29, 2025
33 of 35 checks passed
@bmr-cymru bmr-cymru deleted the bmr-fix-snapshot-origin-report-field branch November 10, 2025 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Bug Something isn't working UI/UX User interface and experience

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

fix: FieldType arguments swapped for snapshot origin field description

1 participant