Skip to content

feat(config): Make Jira query configurable #4

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.

Sign up for GitHub

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

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

feat(config): Make Jira query configurable #4

celebdor wants to merge 1 commit into from

Conversation

@celebdor
Copy link
Contributor

@celebdor celebdor commented May 16, 2025 •
edited by coderabbitai bot
Loading

Adds a new query field to the config struct that allows the server config to determine what will be synced.

Summary by CodeRabbit

  • New Features
    • Added support for customizing the Jira JQL query used for issue synchronization via configuration files and deployment manifests.
  • Documentation
    • Updated configuration examples in the README and templates to illustrate the new query field for Jira integration.

@celebdor
feat(config): Make Jira query configurable
d7b5239 
Adds a new query field to the config struct that allows the server
config to determine what will be synced.

Signed-off-by: Antoni Segura Puimedon <antoni@redhat.com>
@coderabbitai
Copy link

coderabbitai bot commented May 16, 2025 •
edited
Loading

Walkthrough

A new configurable query field for Jira JQL queries was introduced across configuration files, templates, and the main application logic. The code now reads the Jira query from configuration instead of using a hardcoded value, allowing users to specify custom filters for Jira issue synchronization.

Changes

File(s) Change Summary
README.md Updated the Jira connection example to include a query field demonstrating JQL usage.
config.yaml.template Added a query configuration entry under the jira section with a detailed sample JQL query.
main.go Added a Query field to the Config.Jira struct, updated config loading to support it, and replaced a hardcoded JQL string with the configurable value.
manifests/backport-dashboard.yaml, manifests/backport-dashboard.yaml.template Added a query key with a placeholder value under the jira section in the config.yaml ConfigMap for deployment and template files.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ConfigFile
    participant Application
    participant Jira

    User->>ConfigFile: Edit config.yaml to set jira.query
    Application->>ConfigFile: Load configuration (including jira.query)
    Application->>Jira: Query issues using jira.query from config
    Jira-->>Application: Return filtered issues
    Application->>User: Process and display synchronized issues
Loading

Poem

In configs and code, a query appears,
To filter Jira bugs, as the dashboard steers.
No more hardcoded lines, just set and deploy,
Custom JQL brings admins much joy!
With YAML and Go, the sync is now neat—
A rabbit’s delight, configuration complete! 🐇

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 16th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 3060c04 and d7b5239.

📒 Files selected for processing (5)
  • README.md (1 hunks)
  • config.yaml.template (1 hunks)
  • main.go (3 hunks)
  • manifests/backport-dashboard.yaml (1 hunks)
  • manifests/backport-dashboard.yaml.template (1 hunks)
🔇 Additional comments (7)
config.yaml.template (1)

3-4: Good implementation of the configurable Jira query!

The new multiline query field is well-structured and contains comprehensive filtering criteria for HyperShift-related issues. The query targets OCPBUGS project with specific components, requires non-empty "Target Backport Versions", and excludes issues with "depends on" links.

manifests/backport-dashboard.yaml.template (1)

62-62: LGTM! ConfigMap template updated appropriately.

The addition of the placeholder query field in the Jira configuration section is consistent with the changes in the config template.

README.md (1)

123-123: Documentation updated correctly.

The README now includes a simple example of the new Jira query configuration option with "project = FOO", which provides clear guidance to users setting up their configuration.

manifests/backport-dashboard.yaml (1)

46-46: ConfigMap updated appropriately.

The addition of the placeholder query field in the Jira configuration section is consistent with the template and other configuration changes.

main.go (3)

29-29: Config struct updated correctly.

The new Query field in the Jira struct is properly tagged with mapstructure to match the YAML configuration.

60-63: Good implementation of default Jira query!

Setting a default query value ensures backward compatibility for existing deployments that haven't updated their configuration yet. The default value matches the previously hardcoded query, maintaining consistent behavior.

272-272: Successfully replaced hardcoded query with configurable option.

The previously hardcoded JQL query is now replaced with the configurable value from the configuration, completing the feature implementation.

✨ 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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@celebdor