Appvibe CircleCI Integration
Overview of Features
Key Features
Feature 1:
Add Links: Embed CircleCI links directly into Jira issues for quick access to spreadsheets.
Feature 2:
Edit Links: Update or modify embedded CircleCI links as the spreadsheet changes.
Feature 3:
Remove Links: Remove links when they are no longer relevant.
Feature 4:
View Links in Preview and Full Screen: Preview CircleCI content or expand it to full screen for a more detailed view.
Feature 5:
Sort Links: Organize CircleCI links by custom criteria, name, or date for efficient access and management.
Feature 6:
Realign Links: Adjust the positioning of CircleCI links within the Jira issue to maintain clarity and ease of use.
Feature 7:
View Links in List or Tile View: Toggle between list or tile layout for viewing links, accommodating different visual preferences and organizing needs.
Feature 8:
Manage Permissions: Control who can view and interact with CircleCI links embedded in Jira, ensuring secure and appropriate access.
Feature 9:
View Link History: Access the history of changes made to each CircleCI link, providing transparency and accountability for link modifications.
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.
- Search for Appvibe CircleCI Integration
- Use the search bar to find the app.
Step 3:
Install the App
- Click Get app or Try it free.
- Confirm the installation and grant the required permissions.
Step 4:
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 5:
Start Using the App to add and view links for CircleCI
- Open any Jira issue to view, add, or manage CircleCI 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 CircleCI design.
- Title – A meaningful name for the design. (optional)
Step 2:
View a Link
Step 1:
Inside a Jira issue, find the link you want to view and click the view icon for that link.
Step 2:
An inline popup will appear showing your CircleCI. You can also 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, allowing you to edit the following:
Step 2:
Embedded URL – The link to your CircleCI design.
Title – A meaningful name for the design. (optional)
Click the save button again to add your CircleCI 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 CircleCI link.
Advanced
View Link History
Step 1:
Begin by installing the Appvibe CircleCI Integration app from the Atlassian Marketplace into your Jira instance. This app facilitates the seamless integration of CircleCI directly within Jira.
Step 2:
After the installation, navigate to any Jira issue where you want to track CircleCI pipeline links. Any changes made to these CircleCI links will now be captured by the app.
Step 3:
Each modification to the CircleCI links is meticulously tracked and stored both at the specific link level and the overall Jira issue level. This ensures you have a detailed history of all interactions.
Step 4:
To view the history of modifications, access the CircleCI integration panel on the Jira issue. Here, you will find a comprehensive log of all changes made to the links associated with that specific issue.
Step 5:
Utilize this history to monitor and audit the evolution of the CircleCI configurations in context with your development activities and project management within Jira.
Link Permissions
Step 1:
Go to the Appvibe CircleCI Integration configuration page, or click "Permission" from within the link settings in a Jira issue.
Step 2:
Select the desired permissions for each user to control which users have access to the links in a given Jira issue.
- Viewer: Users with view permission can see the link in the Jira issue.
- Editor: 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.
Link permissions are managed at a system level, so ensure you have admin privileges to manage these settings.
Help
FAQ
What if the CircleCI link doesn’t load?
Ensure the link is public and accessible. If CircleCI blocks embedding, try opening it in a new tab.
Can I add multiple links to one issue?
Yes, you can add multiple CircleCI links to each Jira issue.
How secure are my CircleCI links?
All links and related meta data 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 CircleCI Integration app facilitates streamlined management and accessibility of CircleCI configurations within Jira. By embedding seamlessly, the app ensures your team remains focused on their tasks without the need to toggle between different tools.
Support Contact:
If you require further assistance, please connect with your Jira administrator or visit our Support Page at https://www.appvibe.com/support