Appvibe SonarQube Integration
Overview of Features
Key Features
Feature 1:
Add Links: Easily embed SonarQube links directly into Jira issues, ensuring quick access to related spreadsheets. Enhance workflow efficiency by linking relevant SonarQube data with your Jira issues for seamless information retrieval.
Feature 2:
Edit Links: Keep your embedded SonarQube links up-to-date by modifying them as required. This feature allows you to make changes in line with updates in the spreadsheet, ensuring all linked data remains accurate and relevant.
Feature 3:
Remove Links: Streamline your Jira issues by removing SonarQube links that are no longer needed. This function helps maintain a clean and organized workspace by eliminating outdated or irrelevant links.
Feature 4:
View Links in Preview and Full Screen: Gain flexibility in how you interact with SonarQube content by previewing links directly within Jira issues or expanding them to full screen for a more detailed view. This adaptability enhances user experience and interaction with embedded data.
Feature 5:
Sort Links: Organize your SonarQube links efficiently by sorting them according to custom criteria, name, or date. Improved organization helps in quick navigation and finding essential links without hassle.
Feature 6:
Realign Links: Adjust the placement of SonarQube links within your Jira issues to suit your preferences or align with priority. This feature allows you to customize the layout for optimal link presentation.
Feature 7:
View Links in List or Tile View: Tailor your link viewing experience with the option to toggle between list or tile layouts. Choose your preferred view for better clarity and easier navigation depending on the amount of linked content.
Feature 8:
Manage Permissions: Ensure data security by controlling who can view and interact with embedded SonarQube links. This feature allows you to specify permissions and maintain control over access to sensitive information within Jira.
Feature 9:
View Link History: Track the evolution of each SonarQube link with access to a comprehensive history of changes. This feature provides insights into link modifications over time, enhancing transparency and traceability.
Getting Started
Installation
Step 1:
Log in to Jira
Ensure you are logged in with Admin privileges.
Step 2:
Open the Atlassian Marketplace
In Jira, click on Apps → Explore more apps to open the Marketplace.
Step 3:
Search for Appvibe SonarQube Integration
Use the search bar to find the app.
Step 4:
Install the App
Click Get app or Try it free.
Confirm the installation and grant the required permissions.
Step 5:
Configure the App
Once installed, go to Manage Apps in the Admin section to ensure it's enabled.
The panel will now appear in your Jira issue view.
Step 6:
Start Using the App to add and view links for SonarQube
Open any Jira issue to view, add, or manage SonarQube links directly.
Working with Links
Add a Link
Step 1:
Inside a Jira issue, click the "Add" button. A form will appear inline, allowing you to enter:
- Embedded URL: The link to your SonarQube design.
- Title: A meaningful name for the design. (optional)
Step 2:
View a Link
Step 1:
Inside a Jira issue, locate the link you want to view and click the view icon associated with that link.
Step 2:
An inline popup will appear, displaying your SonarQube. You can opt to click this for full-screen viewing.
Edit a Link
Step 1:
Inside a Jira issue, find the link you want to edit and click "Edit" from the link dropdown. A form will appear inline.
Step 2:
Edit the following:
- Embedded URL – The link to your SonarQube design.
- Title – A meaningful name for the design. (optional)
Click the save button to add your SonarQube link to the Jira issue.
Delete a Link
Step 1:
Step 2:
Step 3:
You will be prompted to confirm if you want to delete this SonarQube link.
Advanced
View Link History
Step 1:
Install the Appvibe SonarQube Integration app in your Jira environment. Navigate to the Jira Marketplace to find the app, and follow the installation instructions provided.
Step 2:
Once installed, integrate SonarQube with your Jira issues. This involves connecting your SonarQube project links to the relevant Jira issues, which allows you to track code quality metrics directly within Jira.
Step 3:
Make any modifications to the existing SonarQube links in the Jira issues as required. Each modification, including changes to link status or details, will be automatically tracked and recorded.
Step 4:
View the history of SonarQube link modifications in a Jira issue at any time. This history is accessible from either the specific link level or from within the Jira issue dashboard, providing an audit trail of changes.
Step 5:
Utilize the historical data stored to analyze changes, assess code quality trends, and ensure compliance with project standards. This data can assist in identifying issues early and ensuring alignment with your development goals.
Step 6:
Leverage the integration capabilities to enhance your Jira experience. By consolidating issue tracking with code quality insights, teams can improve collaboration, streamline processes, and make more informed decisions.
Link Permissions
Step 1:
Go to the Appvibe SonarQube Integration configuration page, or select "Permissions" from within the link settings in a Jira issue.
Step 2:
Manage which users have access to the links in a given issue by selecting the desired permissions for each user at a system level:
- Viewer: Users with view permission can see the link in the Jira issue.
- Editer: Users with edit permission can add, edit, or remove links in the Jira issue.
- Admin: Users with admin permission can manage link permissions for other users.
Help
FAQ
What if the SonarQube link doesn’t load?
Ensure the link is public and accessible. If SonarQube blocks embedding, try opening it in a new tab.
Can I add multiple links to one issue?
Yes, you can add multiple SonarQube links to each Jira issue.
How secure are my SonarQube links?
All links and related metadata are stored within Atlassian's Forge platform. Our app data is stored using Forge's hosted storage solutions, which are integrated into Atlassian's cloud infrastructure. This setup ensures that app data benefits from the same data residency features as Atlassian's core products, allowing administrators to control where the data is hosted.
Support
Support and Contact
Overview:
We are here to help you. The Appvibe SonarQube Integration app simplifies the process of managing and accessing SonarQube designs directly within Jira. With seamless integration, your team can maintain focus on tasks without the need to switch between different tools.
Support Contact:
If you need further assistance, contact your Jira administrator or reach us on our Support Page at https://www.appvibe.com/support