--- language: "en" --- # Slack Connector for Bamboo ## Documentation * ### [Slack Connector for Bamboo Guide](https://help.moveworkforward.com/Slack-Bamboo-Integration/slack-bamboo-connector-guide.md) Slack Connector for Bamboo Guide explains how to setup, presents demos and troubleshooting information about Slack Atlassian Bamboo notifications. * ### [Slack Connector for Bamboo support of Bamboo Specs](https://help.moveworkforward.com/Slack-Bamboo-Integration/slack-bamboo-connector-support-of-bamboo-specs.md) Slack Connector for Bamboo supports Java and YAML Bamboo Specs. * ### [Release notes of Slack Connector for Bamboo](https://help.moveworkforward.com/Slack-Bamboo-Integration/release-notes-of-slack-atlassian-bamboo-connector.md) Change log of Slack Connector for Bamboo for Atlassian Bamboo Data Center --- language: "en" --- # Release notes of Slack Connector for Bamboo Change log of Slack Connector for Bamboo for Atlassian Bamboo Data Center ## 1.12.22 *Date* : 2022-12-22 Notable improvements are: * Improvement : Added support for build artifact links. ## 1.09.01 *Date* : 2022-09-27 Notable improvements are: * Improvement : Initial release of Slack Bamboo connector for Slack notification from Atlassian Bamboo. --- language: "en" --- # Slack Connector for Bamboo Guide Slack Connector for Bamboo Guide explains how to setup, presents demos and troubleshooting information about Slack Atlassian Bamboo notifications. You can read more about connecting Bamboo and Slack at [Move Work Forward](https://www.moveworkforward.com/product/slack-bamboo-connector). The App is available at Atlassian Marketplace - [Slack Connector for Bamboo](https://marketplace.atlassian.com/apps/1229066/slack-bamboo-connector?hosting=datacenter&tab=overview). ## Benefits Atlassian Bamboo is a powerful continuous integration and delivery tool that helps development teams automate their build, test, and deployment processes. With the integration of Slack, teams can stay up to date on the state of their build pipelines and receive all types of notifications in real time. One of the key benefits of using Bamboo and Slack together is the ability to track the progress of build pipelines and receive alerts when there are any issues or failures. This helps teams stay on top of their development cycle and identify problems as soon as they arise, reducing the time it takes to fix issues and get code into production. In addition to notifications, Bamboo also allows teams to create and manage build specs directly and integrate build plan Slack notifications. Finally, Bamboo's integration with Slack also includes the ability to access build output artefacts directly from within the Slack interface. This means that teams can quickly and easily access the results of their builds, including test results and other important information, without having to switch between tools or navigate away from their primary work environment. Overall, the integration of Bamboo and Slack helps teams save time, reduce development cycle time, and stay up to date on the state of their build pipelines. By bringing all of these capabilities together in a single, integrated platform, teams can work more efficiently and effectively, helping them to deliver high-quality software faster. ## Demos General Slack Connector for Bamboo demo ## Configuration Create a Slack Incoming Webhook like described in the official Slack documentation - When you get a Slack Incoming Webhook URL, you need to go to your build plan and follow these steps: Go to the `Configuration plan` ![image-20221228-142951.png](https://help.moveworkforward.com/__attachments/a_d7f29343d9c240e71cdec47a988d639517aa010da167f2cb5cfdea9f55c37dc1/image-20221228-142951.png?cb=4cfe28a6f431b6929460c8c450e2b7a2) Visit the `Notifications` section ![image-20221228-143029.png](https://help.moveworkforward.com/__attachments/a_697bd552e3cfeb8edd1be2cc63db532aa07cc8e9845ec02560fa79f729e082df/image-20221228-143029.png?cb=8a403d53b48680eb98f29ed3d84a8201) Click `Add notification` and select there Recipient type `Slack` ![image-20221228-143100.png](https://help.moveworkforward.com/__attachments/a_c8dbb524d2e01a9c13d4ff7706b6a8983c3bc424b5ed04b8ed181d89ccd9bfec/image-20221228-143100.png?cb=8785d34f2fc94ae5d0503bb7d79cdefe) Insert the required fields: * Slack Webhook URL * Slack Channel name * (optional) Slack user, on which behalf the messages are published * (optional) Enable `Include artifacts` to have the links to the build output artifacts ![image-20221228-143229.png](https://help.moveworkforward.com/__attachments/a_edefef31c2574ae4679d6e409331e0d518d6e36366e08255832e4d80487fef6f/image-20221228-143229.png?cb=cff103d65f331ed1d1bbc990fb67ea52) ### Bamboo Specs mode Check it out on YouTube - ## Frequently Asked Questions You can find the frequently asked questions on the [Slack Connector for Bamboo product page](https://www.moveworkforward.com/product/slack-bamboo-connector). ## Bamboo Build Plan configuration Navigate in Bamboo to the build plan you want to receive notifications from. ![image-20220904-160457.png](https://help.moveworkforward.com/__attachments/a_ee912ebb572598ff06897ce05300e6ef8ae211c728ac5c9df087a9208b7ef299/image-20220904-160457.png?cb=7fbbcf1806fa701412bdb83760f14f92) Go to the Notifications tab and click `Add notification`. ![image-20220904-160526.png](https://help.moveworkforward.com/__attachments/a_b98de0538ebd48f108ac7ee56604b35f8f29d8d92726dd2190797f32e2b6c92d/image-20220904-160526.png?cb=9ba41d4ae5a4a017a01d241d778a040a) After you add the notification setting, you should see the screen below. ![image-20220904-160612.png](https://help.moveworkforward.com/__attachments/a_0b8cfb9c2a6441a1006e153172d33a6b9336c17cdd51841cee819fb710dff032/image-20220904-160612.png?cb=4dc24cb5b04685fe1dd5767fb083c201) From now on, your channel in Slack will get notified, and you should see something similar. ![image-20220904-160638.png](https://help.moveworkforward.com/__attachments/a_483dd62e1137adcff6ca3f1ca0e68f81578b169cef30029403a626ee3cf85a60/image-20220904-160638.png?cb=95fe86488cd601c78f85dd28143702d6) ## Bamboo Build Task configuration Another option is to use Atlassian Bamboo build tasks to notify Slack channels about particular events. You can also use all Bamboo variables inside the message. Bamboo variables are described here - ![image-20220904-160944.png](https://help.moveworkforward.com/__attachments/a_2f6dd9e91310e710b88f0bda274d688a4270b7c665dba01f649b5bb2bffddcdf/image-20220904-160944.png?cb=5d7bb80c845f42fb294251fe166f58de) The resulting message may look similar to the following. ![image-20220904-161021.png](https://help.moveworkforward.com/__attachments/a_872d3fd3bc76af31f8eb9550469400f66deabcda7931f570c409a052456646c5/image-20220904-161021.png?cb=767623926b763a190b4ed199ee768013) ## Bamboo Java and YAML support [Slack Connector for Bamboo support of Bamboo Specs](https://help.moveworkforward.com/Slack-Bamboo-Integration/slack-bamboo-connector-support-of-bamboo-specs.md) ## Troubleshooting ### Update Please make sure that you have the latest App version, we fix issues pretty quickly, and there is a chance that your problem has been fixed. #### Debug mode Go to **Bamboo administration \> System -\> Log settings**. Then add the app key (see table below) for "Classpath" and choose DEBUG as "Type". You should then see log messages of the app with severity DEBUG either in your Bamboo Server log (BAMBOO_HOME/logs/atlassian-bamboo.log) or in the Remote Agent server log. The app namespace is **com.moveworkforward.bamboo.slack.notifier** The additional [guide](https://confluence.atlassian.com/bamboo/logging-in-bamboo-289277239.html#LogginginBamboo-Configuringthelevelofloggingonremoteagents) from Atlassian. #### Download the support zip You can send us the support zip, which contains the log files. You can download it following this [official Atlassian documentation](https://confluence.atlassian.com/support/create-a-support-zip-790796819.html). #### Getting help You can create a Jira [Service Desk](https://moveworkforward.atlassian.net/servicedesk/customer/portal/1) support request with all information you can gather; please include the screenshot of the configuration (please don't worry about the webhook URLs, we won't store or use them) and the logs or errors you could find in the browser or on the server-side. *Updated* : 2025-08-19 --- language: "en" --- # Slack Connector for Bamboo support of Bamboo Specs Slack Connector for Bamboo supports Java and YAML Bamboo Specs. ## Video demo You can watch this short video demo on YouTube - ## Java Bamboo Specs support Slack Connector for Bamboo supports Java specs for notifications and build tasks. Below is an example of the Slack Build Task definition. ... .tasks(new ScriptTask() .description("Run") .inlineBody("exit 0"), new AnyTask(new AtlassianModule("com.moveworkforward.bamboo.slack-notifier:slackBuildTask")) .description("Slack test task") .configuration(new MapBuilder() .put("slack_message", "The build finished successfully.\n\n${bamboo.buildPlanName} | ${bamboo.buildKey} | ${bamboo.shortJobName}") .put("slack_channel", "bamboo") .put("slack_user", "") .put("slack_webhookUrl", "https://hooks.slack.com/services/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KR") .build())))) ... Here is how this Bamboo build task looks in the UI. ![image-20220904-083347.png](https://help.moveworkforward.com/__attachments/a_e5ca90bda5f75c7f8006355127bdc9a976660d3de133af64046858eaa7587982/image-20220904-083347.png?cb=7eea3fb7cefd4ee8e904865ef95ade42) And here you can set up the notification. .notifications(new Notification() .type(new PlanCompletedNotification()) .recipients(new AnyNotificationRecipient(new AtlassianModule("com.moveworkforward.bamboo.slack-notifier:recipient.slack")) .recipientString("https://hooks.slack.com/services/T1MXXXQFK/B040XXXF1L5/LjkpHWXQIxXXXDClQOIQq7LKR|bamboo|Move Work Forward|true|"))); The notification parameters are: * Slack webhook URL * Notifier name * If the task is enabled Here is how this notification looks in the UI. ![image-20220904-161405.png](https://help.moveworkforward.com/__attachments/a_d60a494533bdf3d7668193756660d47512affa83ef59e5f6d4a43e96761643b4/image-20220904-161405.png?cb=06e3a5c17df8c026fd4554b4b5ae29ba) ## YAML Bamboo Specs support Slack Connector for Bamboo supports YAML specs for notifications and build tasks. Below is an example of the Slack Build Task definition. ... - any-task: plugin-key: com.moveworkforward.bamboo.slack-notifier:slackBuildTask configuration: slack_message: |- The build finished successfully. ${bamboo.buildPlanName} | ${bamboo.buildKey} | ${bamboo.shortJobName} slack_channel: bamboo slack_webhookUrl: https://hooks.slack.com/services/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 description: Slack test task ... Here is how this Bamboo build task looks in the UI. ![image-20220904-161430.png](https://help.moveworkforward.com/__attachments/a_b12e882304f280c38d06b09791325dfd27d1117de986a0076ce952a0035143f9/image-20220904-161430.png?cb=1c1d4199bb4a899abded76a45b9edef8) The notifications in YAML are not supported (by Bamboo itself). *Updated* : 2022-09-04 --- language: "en" --- # Autodesk ## Documentation * ### [Model Catalogue](https://help.moveworkforward.com/autodesk/model-catalogue.md) Autodesk Inventor Model Catalogue permits to manage your models with ease. * ### [Place Fasteners](https://help.moveworkforward.com/autodesk/place-fasteners.md) Autodesk Inventor Place Fasteners application helps add bolts, screws, nuts, rivets, and washers to your designs. * ### [Quick Section View](https://help.moveworkforward.com/autodesk/quick-section-view.md) Autodesk Inventor Quick Section View app allows you to see a cut of the design in a couple of clicks. --- language: "en" --- # Model Catalogue Autodesk Inventor Model Catalogue permits to manage your models with ease. ![Demo1-20250430-080314.png](https://help.moveworkforward.com/__attachments/a_961ffb428653ffad1512ef0e3a35a1256eb0b7cbf1a5c0da0ebe86bc2c192558/Demo1-20250430-080314.png?cb=8a420019ccbc45076c2d654eb62e78b0) ## Description **Design Catalog** is a desktop add-in application for Autodesk Inventor that allows engineers to create a **custom collection of models** within Autodesk Inventor for quick access to models and drawings, easily copy and insert them into the current design. The models in the catalog are grouped by pages and categories. Design Catalog can be shared between other engineers in the department. Catalog allows a deep copy of the entire assembly including drawings and linked files. The model in the catalog can have pre-configured constraints, thus insertion of the model is done way more. ✅ **Design Catalog functions as a collection of intelligent shortcuts to local Inventor files --- no data is uploaded or stored externally. All catalog information, metadata, and previews remain securely on user's machine or local network.** ## Video tutorial ### Features * Users can group models into **Pages** and **Categories**. * Each catalog item provides model details: a **large image** , model **iProperties**, linked drawings, PDFs, etc. * Users can **open** , **copy** , or **insert** any catalog model. * Users can create a **deep copy** of any catalog model, **including associated drawings**. * Users can define **naming rules** for copied models by adding or removing **prefixes** and **suffixes**. * Users can preconfigure the**constraint sequence** for each model. * Models can be inserted with constraints as a **single unit** , **one-by-one** , **by group** , or by **multiple groups**. * Models can also be inserted without constraints into **free modeling space**. * The catalog supports **reordering** of models within a category, as well as reordering of categories and pages. Models can be dragged between categories. ## General Usage Instructions 1. Install the application form the Autodesk App Store. **Design Catalog** command buttons are located on: * "**Assemble**" ribbon panel of the Assembly environment, * "**3D Model**" panel of Part Environment * "**Tools**" in Zero Document Environment (when non document opend) The installer that ran when you downloaded this app/plug-in from Autodesk App Store will start installing the app/plug-in. OR, simply double-click the downloaded installer to install the app/plugin. ![image-20250506-094028.png](https://help.moveworkforward.com/__attachments/a_4430a0f578e76c36f7661c03ded18cc8864378b8fc31db79a8eecaa4277d5b26/image-20250506-094028.png?cb=7505f7e1bb910b69d621cff34f82c5c4) 2. Start Inventor 3. Run "**Design Catalog** " button from "**Tools**" tab in Zero Documents Inventor Environment 4. You can see the **Demo Page** is opened in the Design Catalog 5. Do **left-mouse click** on any card and you will see the panel with details appered ![CardDetails-20250430-091213.png](https://help.moveworkforward.com/__attachments/a_5750b087f6b74152c6b477ad8fe7e31d8e6496b7a7829f1f7b8fb59e3a09f4c9/CardDetails-20250430-091213.png?cb=b2ca06fd07205b367705b18c5e024177) 6. Do **right-mouse click** on any card, then click "Open" command from context menu - Inventor will open the selected model ![CardOptions-20250430-091031.png](https://help.moveworkforward.com/__attachments/a_9c3e5d840950ca1a2362bb6d6e01dbb80e875cefc6b8a91f12ac077fcac93215/CardOptions-20250430-091031.png?cb=8af1cf038bc2b259da40e8593d86ba4c) Card context menu view 7. Open any assembly document, run the application from "**Assemble** " panel, do right-mouse click on any card, then click "**Add Free**" command from context menu - Inventor will insert the selected model into your opened assembly document 8. Run Design Catalog again, click "white circle with plus" button (the last tab at the top), you will be prompted to enter the new Page name. ![image-20250506-092937.png](https://help.moveworkforward.com/__attachments/a_95fd04c8928d1aa292b55eda97460809b7e1edb6e900bc06b7feb866984b319e/image-20250506-092937.png?cb=4ca836d87ad604b252ababdeafaf913f) 9. After the new page is created, click "Add Category" button to add new category. Enter new category name. 10. Click "+ Add File" and then click "Open File". Browse any Inventor file and click Save. The new catalog item is added. ![image-20250506-093214.png](https://help.moveworkforward.com/__attachments/a_77b529fa626a1044ed0b2428bbf5d199ff49f82db62f44906eca78f9acec0d15/image-20250506-093214.png?cb=b6ec9a019ecc04828c506c103c28d7f7) ![image-20250506-094854.png](https://help.moveworkforward.com/__attachments/a_28b024edc92e81550fd579b7ef4f0f64f9d60eafe3f25d166ab4117c5d0bafd1/image-20250506-094854.png?cb=b561f38a2e93aafaf9d7719a1f7757f9) ## Technical Notes * Button **''Add Free''** inserts the model without constraints. Always enabled * Buttons ''**Add One'', ''Add One By One'', ''Add Group''** and**''Add Multi Group"** insert the model and start user-defined constraining sequence. Enabled only when constraints are defined * Buttons **''Add Group''** and**''Add Multi Group"** are available when there is **only 1** defined constraint with type of **Insert Mate** or **Insert Flush** ## Trial and Subscription The app provides a **30-day free trial** with full functionality. After the trial period expires the subscription has to be purchased via Autodesk App Store or with an invoice. Subscription information can be viewed from button **Subscription** on the top bar. ![image-20250506-093617.png](https://help.moveworkforward.com/__attachments/a_19cb7170f5cb2ac69fb358ca7113d701797212d8700705ab95921ee1ea60e4ea/image-20250506-093617.png?cb=34b25e84202dc2fdd7dce35311581e51) *Updated* : 2025-05-07 --- language: "en" --- # Place Fasteners Autodesk Inventor Place Fasteners application helps add bolts, screws, nuts, rivets, and washers to your designs. ![9c860575-a733-4281-b3da-da7c7a037835.png](https://help.moveworkforward.com/__attachments/a_fe1a8f1282b0a8e77d086ed63fcb395df6f987110d5d7708fb482e4f0a0339b2/9c860575-a733-4281-b3da-da7c7a037835.png?cb=0d7aeaf08849e3c1726ead07e3f2cd32) ## Description **Autodesk Inventor Place Fasteners**is a desktop add-in application for Autodesk Inventor allowing users to automatically insert fasteners into 3D modelling space with automatic size selection based on the sizes of the holes or slots. Fasteners can be sourced from the user's **custom library** or **Content Center**. Supports 5 material types for each fastener. To add a bolted connection, the user selects only two edges, allowing the application to determine the diameter and length of the inserted fasteners. ### Place Fasteners on Autodesk App Store [https://apps.autodesk.com/INVNTOR/en/Detail/Index?id=713745016472190898\&appLang=en\&os=Win64](https://apps.autodesk.com/INVNTOR/en/Detail/Index?id=713745016472190898&appLang=en&os=Win64) ## **Video tutorial** ### **App Functionality** * Supports both **metric and imperial** fasteners. * Compatible with all **custom libraries** and part types and **Content Center** , including integration with **Autodesk Vault**. * Allows selection from **5 material types** per fastener item. * Can insert fasteners into both **round and slotted holes**. * Automatically **validates the model** for inconsistencies. For example, if a smooth Ø8 mm hole is selected alongside an M10 threaded hole, a relevant warning is displayed. * **Detects interference** between fasteners and the model. * Fasteners are highlighted in red if a collision is detected. * Fasteners are highlighted in yellow if placed in holes with no clearance (e.g., inserting an M8 fastener into a Ø8 mm hole). * Automatically enables a **half-section view** state for improved visualization. * Supports placing fasteners into **folders**, with customizable folder names. * Supports placement in **free space** without constraints. * Allows toggling between **fully and partially threaded hex head bolts**. * Enables **propagation of fasteners across multiple faces** simultaneously. * Supports insertion **Content Center items as custom parts** into specified folder. ### Usage Instructions Download Place Fasteners application from Autodesk App Store. Run the application installer and follow installer instructions. After installation is done Place Fasteners command appears under the "**Assemble** " ribbon panel of the **Assembly environment.** Before you can start placing fasteners, the application has to be configured. #### Place Fasteners Configuration Run the application, on the "**Main window** " click "**Settings**" and select your units of measure: metric or inch. ![image-20250506-072746.png](https://help.moveworkforward.com/__attachments/a_50d6e99910901718e4b4407f57c9b6f3d7fe708fa80e8fa7346e4fae956a4ef2/image-20250506-072746.png?cb=f886a0e9c0ed966fb5ab6f1abcd1e290) Setting window Then select the fastener item you want to modify and click "**Edit**". Family Customization window will appear on the screen. ![image-20250506-072845.png](https://help.moveworkforward.com/__attachments/a_f43819dd76c918c499379d78e3e307fdbcc8ebaf008a0cd747663613a2dc6084/image-20250506-072845.png?cb=326d899e65daf16e822735fcffb6301e) Family Customization window There you have two main options for defining the fasteners. First is to use **Content Center** , second is to use your own**custom library files**. A list of all available Content Center families for selected fastener types is shown at the right side of the window. The application supports 5 different materials for each fastener type. So there are **5 "Add" buttons** at the left side of the window. Each button corresponds to a particular material number. If you are going to use **Content Center fasteners**, then select a family in the list and press one of the "Add" buttons. #### Setup Custom Library files If you want to use **your own library files** then enable "**Use from Excel**" checkbox. There you will be displayed with two extra buttons. Click "**Load all data for active item**" to load all information about your local library for the selected fastener type. ![image-20250506-080614.png](https://help.moveworkforward.com/__attachments/a_e276977eeb2bb0cd6a007f5ac1194332d0fd84f05cfa71fe8b27cdb28c964a73/image-20250506-080614.png?cb=56c8963b3461386f3079eeeea003bb7f) Load all data for active item To access the Excel document, go back to the "**Settings** " window and click the "**Excel settings**" button. In the new window, you can open the Excel document or change the link to another file. The Excel document consists of a number of pages, where each page represents a certain fastener type. ![image-20250506-081611.png](https://help.moveworkforward.com/__attachments/a_bef5b82a959f10ecca08a2e8c271643daaed6ff5bfe922271377d17fc8910193/image-20250506-081611.png?cb=c7df382d2ad7a6a76726584be9d82dd3) Families in Excel document Each page contains 5 column groups for 5 materials. For bolts or screws, you must provide the information about the thread size, length and file full path. The edge column is optional. You fill it only when the application fails to select the proper edge for constraining the fastener. To do that go back to "Excel setting" menu and click "Select edge" button. ![image-20250506-080520.png](https://help.moveworkforward.com/__attachments/a_e0cee07f10bc2ac4f2005fee90d9415b564ee98b0113199a1bd8d939d604507e/image-20250506-080520.png?cb=7ba8e9c3c1db73229f93dd0d85fa2653) Excel settings Then, in the Autodesk Inventor window select the fastener edge. The application will show you the corresponding edge number, which has to be copied to the Excel document. Now the application will use the edge you selected for constraining the fastener. For washers and nuts you have to provide the thread size and file full path only. The height and edge columns are optional. Use "Load data for all items" to load all available information from the excel document. #### Start adding fasteners When you are done with the app configuration, select the type of the fasteners set in the main window and the **material**from the drop-down list. If you want to **disable** automatic thread size selection, just get the size from the drop-down list and **enable the check box** next to it. Then the fasteners will be placed with the size defined by the user. **"Bolt full thread"** toggles between bolt families with full thread and partial therad. **"Follow pattern"** checkbox allows you to pick an existing hole pattern and create "Feature-based pattern" of fasteners. **"Create assembly"** places fasteners set as an assembly unit. **"Add One"** - inserts one set of items for the selected hole. The user selects first edge (top) and second edge (bottom). The application automatically identifies the thread size and the bolt length. Of course, length can be changed by the user when fasteners are placed. **"Add One By One"** - after the first fastener set is placed the user can select other holes and the app will copy the first set and constrain it to these holes until "Done" button is pressed. **"Add Group"** - the app places fasteners set for each hole of the same size as the first hole selected by the user on the current face. **"Add MultiGroup"** - works the same way as "Add Group" but the user can select multiple faces. **"Add Free"** - the app places fasteners set just in free model space without constraining to the model. ![image-20250506-074454.png](https://help.moveworkforward.com/__attachments/a_f28efb1b781d49d74da1a0ef542772e33a3b4a68f6b09e434511d48d0ef4b1d4/image-20250506-074454.png?cb=07c9f509a617728d9cbaecdfef665af5) #### How to add fasteners in 4 screenshots |--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | 1. Select a combination of fasteners ![image-20250506-070121.png](https://help.moveworkforward.com/__attachments/a_4409d77ec48342c2014baf8a3b4b2bb0a91087f4c17a2ea6bed22f6f7d57f9a1/image-20250506-070121.png?cb=895d6df9707f81255c8cf35140373346) | 2. Select hole start and end edges ![image-20250506-070200.png](https://help.moveworkforward.com/__attachments/a_7b8b54108f79ebf4b0b7fe639994311f741652a746348d5f53c733a704bf5d05/image-20250506-070200.png?cb=fce0436925cc182a0c236d8525d20f96) | | 3. Adjust the bolt length if needed ![image-20250506-070227.png](https://help.moveworkforward.com/__attachments/a_3874aefb300f458acb48408b4c5832f77c59c5a652da7c4cb92bd6992bae6455/image-20250506-070227.png?cb=7c5e5ac16e3fb84e3e13bf8c17c0d2f7) | 4. Fasteners are placed at each hole ![image-20250506-070411.png](https://help.moveworkforward.com/__attachments/a_40157a94883e1256a3b111c8ee79ab6012a880518534f468e5fbcbcac535bda8/image-20250506-070411.png?cb=733e5f99fc60d962dcf00521b7a0a7c6) | ### **Notes** Only standard (coarse) thread pitches are supported; fine threads are not available at this time. * Supported metric fastener sizes include the following recommended thread sizes: M2, M3, M4, M5, M6, M8, M10, M12, M16, M20, M24, M30, M36, M42, M48, M56, M64 (e.g., a Ø16 mm hole will automatically use an M12 bolt) * Additional sizes may be included in future releases. ### **Trial and Subscription Description** The app provides a 30-day free trial with full functionality. After the trial period expires the subscription has to purchased via Autodesk App Store or with an invoice. Subscription information can be viewed from **Settings window =\> Subscription** ![image-20250506-085611.png](https://help.moveworkforward.com/__attachments/a_b0464c3759365a851d52de4f8043921edb7abd91de97776941669124a3ff52da/image-20250506-085611.png?cb=afd1ff75ea47a80df5f9dca3405c00bd) *Updated* : 2025-05-07 --- language: "en" --- # Quick Section View Autodesk Inventor Quick Section View app allows you to see a cut of the design in a couple of clicks. ![image-20250506-090206.png](https://help.moveworkforward.com/__attachments/a_b8a8b28f4cf717297fa6189cfc9587a33c705908e638a150c7d8f4fdabb11343/image-20250506-090206.png?cb=aa69253ff11cf7a5c455bc1232e40cdf) ## Description **Quick Section View** is a desktop add-inapplication for Autodesk Inventor allowing users to create a half-section view through the origin workplanes or selected geometry. It works the same way in both **assembly** and **part** modeling environments. ### Quick Section View app on Autodesk App Store [https://apps.autodesk.com/INVNTOR/en/Detail/Index?id=5454556850521421748\&appLang=en\&os=Win64](https://apps.autodesk.com/INVNTOR/en/Detail/Index?id=5454556850521421748&appLang=en&os=Win64) ### Video tutorial ## Application functionality * Creates a section view through one of the **origin work planes** * Ends the section view and returns to **full model view** * Select a part or assembly **occurrence to create a section view** through its origin work plane * Select a **circular or conical face** (circular edge) to create a section view through its axis * Select a **straight edge** to create a section view perpendicular to the edge, through its center point * Select a **work plane or planar face** to create a normal half-section view * Hold **SHIFT** and click the app button to start dragging section view * Without any pre-selection, the app works only with origin work planes, which are selected automatically. ## Usage Instructions Download Quick Section View application from Autodesk App Store. Run the application installer and follow installer instructions. After installation is done Quick Section View command appears under: * "**Assemble** " ribbon panel in **Assembly environment** * "**3D Model** " ribbon panel in **Part environment.** Select **any edge, face or work geometry**, then click Quick Section View command and the cross section is created for you. ## **Trial and Subscription Description** The app provides a 30-day free trial with full functionality which starts automatically when the app is run the first time. After the trial period expires the subscription has to purchased via Autodesk App Store or with an invoice. Subscription information can be viewed from **Add-Ins panel =\> Subscription Info**. ![image-20250506-085322.png](https://help.moveworkforward.com/__attachments/a_d26ff884ac935e5bdd6e3356e07da203a45ac5f5147076d8de951f231f82339a/image-20250506-085322.png?cb=9bd2915ccefbe382c4509bd30143d54f) *Updated* : 2025-05-07 --- language: "en" --- # Capybara: GitHub, Linear, Azure DevOps for Jira Service Management ## Documentation * ### [Capybara: GitHub, Linear, Azure DevOps for Jira Service Management](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/capybara-github-gitlab-azure-devops-for-jira-servi.md) Capybara: GitHub, Linear, Azure DevOps for Jira Service Management is a powerful app designed to bridge the gap between support, management and development teams. With Capybara, customer issues move faster, communication becomes clearer, and development progress is transparent, driving efficiency and satisfaction across the board. --- language: "en" --- # Capybara: GitHub, Linear, Azure DevOps for Jira Software and Jira Service Management Guides Step-by-step guides to help you make the most of [Capybara](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?hosting=cloud&tab=overview)'s features: integrating Jira with GitHub, Linear and Azure DevOps. * [How to Link Existing Development Tasks to Jira Issues or JSM Requests](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/how-to-link-existing-development-tasks-to-jira-iss.md) * [How to Create Development Tasks in External Platforms form Jira](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/how-to-create-development-tasks-from-jira.md) * [How to get Real-Time Status Updates on Development Tasks](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/how-to-get-real-time-status-updates-on-development.md) * [How to comment on development tasks from Jira](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/how-to-comment-on-development-tasks-from-jira.md) * [How to sync comments between Jira and Git platforms](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/how-to-sync-comments-between-jira-and-git-platform.md) --- language: "en" --- # Capybara: GitHub, Linear, Azure DevOps for Jira Service Management [Capybara: GitHub, Linear, Azure DevOps for Jira Service Management](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?tab=overview&hosting=cloud) is a powerful app designed to bridge the gap between support, management and development teams. With Capybara, customer issues move faster, communication becomes clearer, and development progress is transparent, driving efficiency and satisfaction across the board. * [Get started](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/get-started.md) * [Capybara: GitHub, Linear, Azure DevOps for Jira Software and Jira Service Management Guides](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/capybara-github-azure-devops-for-jira-service-mana.md) * [Security \& Privacy](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/security-privacy.md) * [Help \& Support](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/help-support.md) --- language: "en" --- # Get started In this guide, you will learn how to set up and use the [Capybara: GitHub, Linear, Azure DevOps for Jira \& JSM](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?tab=overview&hosting=cloud) app in Jira. We'll walk you through installing and connecting the app to your Git platform. ## About the app [Capybara: GitHub, Linear, Azure DevOps for Jira \& JSM](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?tab=overview&hosting=cloud) streamlines collaboration between support, management and development teams by integrating Jira and JSM (Jira Service Management) with GitHub, Linear, and Azure DevOps. The app enables you to: * **Link existing work**: connect Jira issues and JSM requests to existing issues or work items in your external tools. * **Create \& link new tasks**: create new development tasks directly from Jira and JSM and automatically link them for seamless tracking. * **Sync comments**: keep communication aligned by syncing comments between JSM and external platforms. * **Get status updates**: get notified in Jira about task status updates from an external platform. ## Installing Capybara Only **Jira administrators** can install apps on your Jira Cloud instance. If you're not an administrator, click **Request app** to notify your administrator. When requesting the app, explain how it will benefit your team and support your specific use cases. 1. Log in to your Jira Cloud instance. 2. Go to the **Atlassian Marketplace** and search for [Capybara: GitHub, Linear, Azure DevOps for Jira \& JSM](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?tab=overview&hosting=cloud). ![image-20250516-090059.png](https://help.moveworkforward.com/__attachments/a_3ea35e55ea23104323bd38b0f974bcbf792c1eb924e0f7209be1650e37e1abd1/image-20250516-090059.png?cb=3aa621b659f16b83a48454a2880d3511) 3. Click on **Try it free** to initiate the installation, and follow the on-screen prompts to complete the setup. ## Connect to your external platform 💡 **No Admin Setup Required:** The Capybara app does not require any Jira administrator configuration. As a Jira end user, you can simply connect your GitHub, Linear, or Azure DevOps account and begin using the app's features immediately. 1. Open any **Jira issue** or **JSM request**. 2. Open the **Capybara panel** on the Jira issue view: ![image-20241217-122733.png](https://help.moveworkforward.com/__attachments/a_8a60c0480b4c585f53e39fa59d0d18edd427a136484b490834b0372801c92e57/image-20241217-122733.png?cb=fde9d910169e80a4a9722321a79d6a16) 1. You can also access the **Capybara panel** from the **Apps**menu. ![image-20241217-123823.png](/__attachments/a_5e42dd0bb16d323951d0a4c4acd3d9556ac29a61ad12a6d8ab8239e60df8791c/image-20241217-123823.png?cb=ee8b9f2a49ba83c851e1fece47e92137) 3. Select your platform (GitHub, Linear, or Azure DevOps) and click **Connect**. ![image-20250516-090542.png](https://help.moveworkforward.com/__attachments/a_7cdb3a139d7b0a37f413deda5767c231c39e4327d187e7c5680800ef45f8362b/image-20250516-090542.png?cb=0e2cd96088bf159fd854be730a2fcee5) 4. A pop-up window will appear, prompting you to log in. Enter your account credentials and authorize access. 5. To disconnect or switch to another platform, click the **gear icon**. ![image-20250516-090811.png](https://help.moveworkforward.com/__attachments/a_2badaf1a5cb81fac3ec9b7fefd85c734968b834b0b58b0a0f8af59d5941650e9/image-20250516-090811.png?cb=d6d65db67e0f9dc20629d53b0eb07775) ## Start using Capybara After successfully connecting your account, you can: * **Create or link** GitHub or Linear issues, or Azure DevOps work items directly from Jira. * **Sync comments** between Jira and your external development platform. * **Track status updates** for development tasks in real time. 2025-11-14 --- language: "en" --- # Help & Support ## Contact information 📑 Please create a support request [here](https://moveworkforward.atlassian.net/servicedesk/customer/portal/1). 👨‍💻 Schedule a demo call [here](https://calendly.com/move-work-forward-support/cloud-support-call). *Updated* : 2024-12-17 --- language: "en" --- # How to comment on development tasks from Jira [Capybara: GitHub, Linear, Azure DevOps for Jira \& JSM](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?hosting=cloud&tab=overview) makes it easy to comment on linked GitHub, Linear, and Azure DevOps tasks from Jira work items. Follow these steps to add comments to linked development tasks from within Jira issues or Jira Service Management requests. 1. Open the**Jira issue** or**JSM request** that has a linked development task. 2. Go to the linked Azure DevOps work item or GitHub issue or Linear task you wish to comment on and click on ![image-20250205-221100.png](https://help.moveworkforward.com/__attachments/a_b2382b3a1cf04022dcd6bdda817c3a827da5b8fa709fcf269d755327b3c7fe4f/image-20250205-221100.png?cb=d4e33a07b11ccc9c129a580f5f4b1e01) . ![image-20251117-031655.png](https://help.moveworkforward.com/__attachments/a_a5282eb8f6d6365ec1b5110cf5a7e23f01733dc9185296371846866446115fc5/image-20251117-031655.png?cb=1db73a974f244805197f5ed5b85d660e) 3. The pop-up window allows you to comment directly on the linked development task. ![image-20250205-231922.png](https://help.moveworkforward.com/__attachments/a_f8315a3ca6a3e72bb7361b91b28f99357751380c2907711958a3abee254fb5a8/image-20250205-231922.png?cb=dca42cb07deb10c2c7c3c1b61199ae47) 4. Additionally, you can see the history of all comments for this task. The ![image-20250205-232101.png](https://help.moveworkforward.com/__attachments/a_a74c63986f94204c328e9b4ba34ad9e400f505e0978df36d7a72e2d0c4b61ec0/image-20250205-232101.png?cb=4f7a92ac4a8177e65be520f54a48a3de) icon shows the total number of comments. 2025-11-17 --- language: "en" --- # How to Create Development Tasks in External Platforms form Jira [Capybara: GitHub, Linear, Azure DevOps for JSM](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?hosting=cloud&tab=overview) makes it easy to create Azure DevOps, GitHub and Linear tasks from Jira issues or JSM (Jira Service Management) requests. Once created, you can track progress, sync comments, and share updates without switching between tools. Follow these steps to create tasks in external platforms from Jira: 1. Navigate to the **Jira issue** or**JSM request** from which you want to create a task. 2. Locate the**Capybara panel** under the Jira issue description. If the panel isn't visible, click the **Capybara** button or open it from the **Apps** menu above the issue description. ![image-20250204-231138.png](https://help.moveworkforward.com/__attachments/a_17108d0df123eeb43fd112dda650b631735fb2beb973348111f847ff1e83a8b0/image-20250204-231138.png?cb=30aaed6f8f352e1109cccf7fdf2efb26) 3. [++Connect to your development platform++](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/get-started.md#Connect-to-your-Git-platform) (if you haven't already). 4. In the **Capybara** panel, click on **Create new work item / Create new issue**. ![image-20251115-025510.png](https://help.moveworkforward.com/__attachments/a_5e0794377510421193889727b7943192e29e5f2714a2d8bb432d41dc6d976009/image-20251115-025510.png?cb=3eaa4c9c828d55c556ab14297816d778) 5. Enter the relevant details to create your development task: ![image-20250205-025145.png](https://help.moveworkforward.com/__attachments/a_ef2bf690cce5c6daa563b7953e14bf2313384764201594813c9e7e71ee9bfb4e/image-20250205-025145.png?cb=0ca554bb71a6ab97608df27d6c8b9b8e) 6. Configure notifications and comment syncing using the available checkboxes: * **Send a notification comment when the status changes to**: * Choose specific statuses (e.g., "In Progress," "Resolved") from the dropdown selector. * A comment will be posted in the Jira issue when the linked task reaches these statuses. * Status updates for JSM requests will be posted as**internal comments**. * **Duplicate Comments from Git System to this Jira Issue:** * Enable this option to sync comments from the Git platform to the Jira issue. * Comments will be posted as**internal comments** for JSM requests. * *"Duplicate this Jira issue comments to Git system" (Coming Soon)* ***:*** * *This option is currently not implemented but will allow Jira comments to sync back to the Git system in the future.* 7. Click on **Save changes** to create your task in the external platform. The task will now appear in the **Capybara panel** , displaying key details like the **title, status, and assignee**. Created tasks are automatically updated in Jira, allowing you to track progress and stay informed about status changes. ![image-20250205-031731.png](https://help.moveworkforward.com/__attachments/a_40c0c0390eb7f325b26c2f1b2b3e864b75ca9dbd776b8bf63fc62257a82c0622/image-20250205-031731.png?cb=b17439a16140237057d471097d363ac0) *Azure DevOps work item created from Jira* If your **external platform account is disconnected**, all linked URLs remain visible as plain links, ensuring no critical connections are lost. An **Azure DevOps administrator** must connect to Capybara to allow webhooks to be created. If this connection is not established, users can still connect Capybara to their own instance and link work items, but comment updates **will** **not** be received. 2026-02-06 --- language: "en" --- # How to get Real-Time Status Updates on Development Tasks [Capybara: GitHub, Linear, Azure DevOps for JSM](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?hosting=cloud&tab=overview) lets you view real-time status updates for linked GitHub, Azure DevOps, or Linear tasks directly within the Jira work item view. An **Azure DevOps administrator** must connect to Capybara to allow webhooks to be created. If this connection is not established, users can still connect Capybara to their own instance and link work items, but comment updates **will** **not** be received. 1. Open the**Jira issue** or**JSM request** that has a linked development task. 2. Locate the**Capybara panel** under the Jira issue description. ![image-20251117-023725.png](https://help.moveworkforward.com/__attachments/a_7ee82cce1cec4f61581b9935662d2db7906d8d22a6c922f7966be1b25b7e735f/image-20251117-023725.png?cb=a52c65aee7bb90da8a2e5bb76dd31018) 3. Open the **three-dots menu** next to the linked task, then choose **Edit notification settings**. ![image-20250206-222012.png](https://help.moveworkforward.com/__attachments/a_3cc4142287a915214de89af2c863bc48c4fa518a69600a7424ba48f284724e8a/image-20250206-222012.png?cb=1e032243f3079cce652de22469881c07) 4. This will display the **Notification Settings** section beneath the linked task. ![image-20250206-224747.png](https://help.moveworkforward.com/__attachments/a_1c8bebd776bc5ead21a74557b83e974b8b7b451ea35cc64f46f1c3a1e1bd21f4/image-20250206-224747.png?cb=8c58f85a34ceb0d4af1b35de82fe3f75) 5. To receive status updates from the linked task in Jira, enable **Send a notification comment when status changes to:** ![image-20250207-010244.png](https://help.moveworkforward.com/__attachments/a_b49b40aa8fafb81121a490d1b4934283b2d6051d2573aa5d2e0503c843cf99e6/image-20250207-010244.png?cb=f6a84bbc25c29880ba92a1bebdf5903d) 6. Then select the specific statuses you want to be notified about, or choose **All** to receive notifications for every status change. 7. Click **Save** to start receiving Jira issue comments when the linked task's status changes. The **Notifications settings** section is also present when creating a new Azure DevOps work item or GitHub/Linear tasks within **Capybara**panel. 2026-03-06 --- language: "en" --- # How to Link Existing Development Tasks to Jira Issues or JSM Requests [Capybara: GitHub, Linear, Azure DevOps for Jira \& JSM](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?hosting=cloud&tab=overview) makes it easy to connect Jira issues or JSM (Jira Service Management) requests with existing tasks in GitHub, Linear, or Azure DevOps. Once linked, you can track progress, sync comments, and share updates without switching between tools. Follow these steps to link existing development tasks from GitHub, Linear, or Azure DevOps to your Jira issues or JSM requests: 1. Open the**Jira issue** or**JSM request** you want to link to an existing development task. 2. Locate the**Capybara panel** under the Jira issue description. If the panel isn't visible, click the **Capybara** button or open it from the **Apps** menu above the issue description. ![image-20241218-155510.png](https://help.moveworkforward.com/__attachments/a_d311dcba7a5abb82788ff23eb1340a8efda2e06e25cea978a799f57cbf8b4175/image-20241218-155510.png?cb=e2a1e0686b2642897ca975f8460b1a5f) 3. [Connect to your development platform](https://help.moveworkforward.com/capybara-github-gitlab-azure-devops-for-jira/get-started.md#Connect-to-your-Git-platform) (if you haven't already). 4. Click **Add Link** in the Capybara panel. ![image-20241218-150302.png](https://help.moveworkforward.com/__attachments/a_efb7c67c5fccb351214a0a12af66c56b4263d9361c801e3fe193d5775240a68c/image-20241218-150302.png?cb=e9d31f1d6314e9740d9e4a8e42c9849d) 5. **Insert the link** to the GitHub issue, Azure DevOps work item, or Linear task, depending on the platform connected. ![image-20251115-022227.png](https://help.moveworkforward.com/__attachments/a_a9884f73418fb18e58aa5e7cd96a51c9d951ae3f5ecde86fadcd95b4e73e780d/image-20251115-022227.png?cb=5fe104d9a3a08bdb4982e955f220f38d) 6. Configure notifications and comment syncing using the available checkboxes. * **Send a notification comment when the status changes to**: * Choose specific statuses (e.g., "In Progress," "Resolved") from the dropdown selector. * A comment will be posted in the Jira issue when the linked task reaches these statuses. * Status updates for JSM requests will be posted as**internal comments**. * **Duplicate Comments from Git System to this Jira Issue:** * Enable this option to sync comments from the external platform to the Cwill be posted as**internal comments** for JSM requests. * *Duplicate This Jira Issue Comments to Git System (Coming Soon)* ***:*** * *This option is currently not implemented, but will allow Jira comments to sync back to the external platform.* 7. Click **Link**to connect the task to your Jira issue or JSM request. Once linked, the task will appear in the Capybara panel, displaying key details such as **title, status, and assignee**. Linked tasks are automatically updated in Jira, allowing you to track progress and stay informed about status changes. **Capybara** lets you link not only development tasks but also other types of URLs from external platforms, such as Azure DevOps Wiki pages, Git repositories, merge requests, and more. While only certain links display enriched information in Jira, all other links will still appear as standard URLs. If your **external platform account is disconnected**, all previously linked URLs remain visible as plain links, ensuring no critical connections are lost. An **Azure DevOps administrator** must connect to Capybara to allow webhooks to be created. If this connection is not established, users can still connect Capybara to their own instance and link work items, but comment updates **will** **not** be received. 2026-03-06 --- language: "en" --- # How to sync comments between Jira and Git platforms [Capybara: GitHub, Linear, Azure DevOps for Jira \& JSM](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?hosting=cloud&tab=overview) makes it easy to comment on linked GitHub, Linear, and Azure DevOps tasks from Jira work items. Comments can be synced from Jira to your Git platform and vice versa. An **Azure DevOps administrator** must connect to Capybara to allow webhooks to be created. If this connection is not established, users can still connect Capybara to their own instance and link work items, but comment updates **will** **not** be received. 1. Open the**Jira issue** or**JSM request** that has a linked development task. 2. Locate the**Capybara panel** under the Jira issue description. ![image-20251117-023725.png](https://help.moveworkforward.com/__attachments/a_fb6869516992d3522516f6a11427c3fa2c6501d914fdcc46239737cd861ec5ab/image-20251117-023725.png?cb=a52c65aee7bb90da8a2e5bb76dd31018) 3. Open the **three-dots menu** next to the linked task, then choose **Edit notification settings**. ![image-20250206-222012.png](https://help.moveworkforward.com/__attachments/a_1e890c1262345b78c433302398e135ea61a251b1912bdf1cac09cb36a9d9ef45/image-20250206-222012.png?cb=1e032243f3079cce652de22469881c07) 4. This will display the **Notification Settings** section beneath the linked task. ![image-20250206-224747.png](https://help.moveworkforward.com/__attachments/a_55fc83cc64f27239575fe4e8790cf1f7c30a80f292ac8002ce5c26da7023b0f5/image-20250206-224747.png?cb=8c58f85a34ceb0d4af1b35de82fe3f75) The **Notifications settings** section is also present when creating a new Azure DevOps work item or GitHub/Linear tasks within **Capybara**panel. 5. To sync comments from the external platform to Jira, enable **Duplicate comments from Development system to this Jira issue**. ![image-20250206-225646.png](https://help.moveworkforward.com/__attachments/a_a850a2d16b2f710c10de1616f26427192f8d9fa928f1cc7660bec6c9cf1fe07e/image-20250206-225646.png?cb=24b0730873a129991e8a8d75f16882d5) 6. To sync Jira issue comments back to Azure DevOps, GitHub, or Linear, enable **Duplicate this Jira issue's comments to the Git system**. ![image-20250206-225615.png](https://help.moveworkforward.com/__attachments/a_3d9283ab8fd32b3863127077167bec1fcf3ae86fc35b3b13343504aed42a71be/image-20250206-225615.png?cb=7e4b466a31ffa335a063db867dcfa363) 7. Click **Save** to apply your settings. Comments will now sync between platforms, allowing Jira users and developers to collaborate on tasks without switching tools. 2025-11-14 --- language: "en" --- # Security & Privacy Here you can find information about the security and privacy of[Capybara: GitHub, Azure DevOps for Jira Service Management](https://marketplace.atlassian.com/apps/1236139/capybara-github-azure-devops-for-jira-service-management?tab=overview&hosting=cloud)app. * [End User License Agreement](https://mwf-help.atlassian.net/wiki/display/BPW/Security+%26+Privacy) * [Privacy Policy](https://mwf-help.atlassian.net/wiki/display/BPW/Security+%26+Privacy) * [Security practices](https://mwf-help.atlassian.net/wiki/display/BPW/Security+%26+Privacy) * [Security Bug Bounty](https://mwf-help.atlassian.net/wiki/display/BPW/Security+%26+Privacy) * [Security Self Assessment Questionaire](https://mwf-help.atlassian.net/wiki/display/BPW/Security+%26+Privacy) ## End User License Agreement [Move Work Forward \| End User License Agreement](https://www.moveworkforward.com/license-agreement/eula). ## Privacy Policy [Move Work Forward \| Privacy Policy](https://www.moveworkforward.com/privacy-policy). ## Security practices [Move Work Forward \| Security Practices](https://www.moveworkforward.com/security-practices). *Updated* : 2025-06-11 --- language: "en" --- # GitHub, GitLab, Azure DevOps, Gerrit Jira integration documentation ## Documentation * ### [Jigit - GitHub, GitLab, Azure DevOps integration for Jira](https://help.moveworkforward.com/JIGIT/jigit-jira-github-gitlab-integration.md) Integrate Jira Server or Data Center with GitHub, GitHub Enterprise, GitLab, GitLab On-Premises and Gerrit Code Review tool. View your issue related Git activities directly in the Jira's issue view. Streamline development with Jigit Dev Panel on the issue view screen. * ### [Jigit for Jira Cloud](https://help.moveworkforward.com/JIGIT/jigit-for-jira-cloud-github-gitlab-azure-devops-ge.md) Jigit Cloud brings Git development activity directly into Jira Cloud issues. When a developer references a Jira issue key in a pull request, branch, or Gerrit ... * ### [Outdated Jigit guides](https://help.moveworkforward.com/JIGIT/outdate-jigit-guides.md) Jira GitHub and Gitlab integration Jigit - Jira Gerrit Code Review support Jigit - Security \& Architecture Jigit - Data Stored Jira GitHub and GitLab integrati... --- language: "en" --- # Application Architecture Here you can find information about app architecture . Jigit supports **uni-directional** and **bi-directional** integration between Jira and GitHub/GitLab. Uses **REST API**of the Source Code platform (GitLab/GitHub/Gerrit), which means GitLab/GitHub is unaware of Jira, which decreases the security surface. Jira runs a Jigit scheduled task every **2 minutes (configurable)**using the configuration settings for each rule. ![Screen Shot 2020-11-19 at 17.12.22.png](https://help.moveworkforward.com/__attachments/a_22b762a1ee6b300291d8c22c46bf0f4d97587b9f6f68582e6a89a474e71f5bc1/Screen%20Shot%202020-11-19%20at%2017.12.22.png?cb=8d4f632d76fba2e0d49c548ebc73270c) Using the **REST API**of GitLab or GitHub Jigit app retrieves commit and code reviews information and matches them with the Jira issues using the Jira issue key, like DEV-133, F1-454. The commit information is stored in Jira's database (App specific tables) and associated with each issue when the keys are extracted from the git commit message or pull request title. When somebody views an issue, they can see the commits and code reviews in the [**Jigit tab**](https://help.moveworkforward.com/JIGIT/get-started-guide-for-the-jira-end-user.md#Jigit-tab)added by Jigit for that particular issue. For bi-directional integration, the Jigit development panel can be used to be able to create new and link existing feature branches to an issue. ![Screen Shot 2020-11-19 at 17.12.13.png](https://help.moveworkforward.com/__attachments/a_f866e69963c10c0061d2e6aa277e8613511b2918e984547f4425837c3bed559a/Screen%20Shot%202020-11-19%20at%2017.12.13.png?cb=42788665b5fdd4214da5d864738ffca0) *Updated* : 2023-06-02 --- language: "en" --- # Facilitate collaboration between team members Jigit provides a platform for collaboration between developers, testers, and project managers. This helps to ensure that everyone is on the same page and working towards the same goals. [Jigit - GitHub, GitLab, Azure DevOps integration for Jira](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview) enables seamless collaboration and communication among team members by integrating Jira with GitHub, GitLab, Azure DevOps or Gerrit. Here's why it is important: * Eliminates the need to switch between different tools and environments, creating a cohesive space for collaboration. This centralization improves efficiency, reduces communication barriers, and fosters effective teamwork. * Offers real-time updates to keep team members informed about changes and activities happening in GitHub, GitLab or Gerrit platforms. * Team members can communicate and discuss tasks and code changes directly within Jira. Eliminates the need for separate communication channels. * Ensures discussions are closely tied to the relevant items, improving clarity and reducing communication gaps. * Enables team members to have a shared understanding of project progress, tasks, and code changes. Promotes informed decision-making, as team members can access relevant information and insights from multiple platforms. *** ** * ** *** [How to set up GitHub or GitLab integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-github-or-gitlab-integration.md) [How to set up Azure DevOps integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-azure-devops-integration.md) [How to set up Gerrit Code Review integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-gerrit-code-review-integration.md) [How to link Git entities to Jira issues?](https://help.moveworkforward.com/JIGIT/how-to-link-git-entities-to-jira-issues.md) [How to link Gerrit changes to Jira issues?](https://help.moveworkforward.com/JIGIT/how-to-link-gerrit-changes-to-jira-issues.md) [How to create a pull or merge in Jira using the Jigit app?](https://help.moveworkforward.com/JIGIT/how-to-create-a-pull-or-merge-in-jira-using-the-ji.md) [How to create a feature branch in Jira?](https://help.moveworkforward.com/JIGIT/how-to-create-a-feature-branch-in-jira.md) *Updated* : 2024-04-30 --- language: "en" --- # Feature comparison of Jigit vs Git Integration for Jira vs DVCS Feature comparison of Jigit vs Git Integration for Jira vs DVCS **Below you can find a feature comparison between** [**Jigit**](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview)**, Git Integration for Jira and DVCS.** |---------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Feature** | [++**Git Integration for Jira Data Center**++](https://marketplace.atlassian.com/apps/4984/git-integration-for-jira?hosting=datacenter&tab=overview) | [++**DVCS**++](https://confluence.atlassian.com/adminjiraserver/integrating-with-development-tools-using-dvcs-1047552689.html) | [**Jigit - GitHub, GitLab, Azure DevOps integration for Jira Data Center**](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview) | | ++Performance++ | Indexing via cloning. Less API usage. Faster to index than API only. | Combo API + webhook indexing. | Uses webhooks and REST APIs to access metadata. Does not need to clone anything. | | ++Security++ | Clones all repositories. | Limited | Does not access the source code or clone it. | | ++History++ | Cloning gives full access to history | Limited access to history | Can backfill the data from any time required | | ++Storage++ | Clones repositories to Jira home folder and stores data in Jira database | Stores data in Jira database | Stores data in Jira database. | | ++Git service++ | GitHub, GitLab, Azure DevOps, CodeCommit, Gerrit | GitHub, GitLab, Bitbucket | GitHub, GitLab, +Gerrit | | ++Any git repo++ | Available | Not available | any git repo | | ++Automation++ | Automation for Jira | Not available | Partial support | | ++Smart Commits++ | Available | Available | Partial support | | ++Extra Smart Commits++ | #labels, #assign | Not available | Not available | | ++GitHub DependaBot vulnerabilities++ | Not available | Not available | Available | | ++Development information panel++ | Commits, branches, pull requests, tags | Commits, branches, pull requests | Commits, branches, pull requests, reviews, GitHub checks, etc. | | ++Builds / deployments++ | Not available | Not available | **GitHub checks in dev panel** | | ++View full commits in Jira++ | Available | Not available | Available | | ++Pull requests support++ | Available | Basic | Available | | ++Honor git service permissions++ | Available | Not available | Available | | ++Deep linking++ | GitKraken client | Not available | Available | | ++Create branch++ | Available | Only Bitbucket | Available | | ++Create pull request++ | Available | Not available | Available | | ++Control over indexing jobs++ | Interval/cron/webhooks | Webhooks | Interval/cron/webhooks | | ++JQL Search++ | Commits, branches, pull requests | Commits, branches, pull requests | Search issues with particular Git attributes | | ++Dedicated indexing node++ | Available | Not available | Available | | ++Multiple indexing threads++ | Available | Not available | Available | | ++Repository browser++ | Available | Not available | Not available | | ++ScriptRunner support++ | Available | Not available | Available | | ++Active development++ | Available | Basic development | Available | | ++Commercial support++ | Available | Basic support | Available | *Updated* : 2024-02-26 --- language: "en" --- # Features overview [Jigit - Jira GitHub \& GitLab integration](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview) (Server \& DC) ensures a seamless way to track and manage development activities directly from Jira. It provides integration between Jira and Git repositories hosted on platforms like GitHub, GitLab, Azure DevOps, and Gerrit Code Review. | **Feature** | **Description** | **Configuration** | |------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | **Commit indexation** | Link Git commits to specific Jira issues and track them within the Jigit Development Panel on the issue view screen. | Enabled by default; to disable it select the **Use Only for Development Panel** when creating a new configuration. [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Commitindexation) | | **Pull-request indexation** | Link pull/merge requests to specific Jira issues and track them within the Jigit Development Panel on the issue view screen. | To enable ensure that one of the properties is enabled when creating a new configuration: * **Use only for Development Panel** (pull requests will be visible in the Jigit tab and in the Jigit development panel); * **Index pull-requests in repositories** (to show the pull requests in the Jigit tab along with commits); * **Display repositories in the Development Panel** (pull requests will be visible in the Jigit tab and the Jigit development panel). [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Pull-requestindexation) | | **Branch indexation** | Link branches to specific Jira issues and track them within the Jigit Development Panel on the issue view screen. | To enable ensure that one of the properties is enabled when creating a new configuration: * **Use only for Development Panel;** * **Display repositories in the Development Panel.** [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Branchindexation) | | **Smart commits** | Special commit messages that allow you to change the status of a Jira issue. | To enable, ensure that **Smart commits** is enabledand **Smart commits period** is indicated when creating a new configuration. [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Smartcommits) | | **Create branch** | Initiate the feature branch creation within Jira. | To enable any of these functionalities, ensure that: * one of the following properties is enabled when creating a new configuration: * **Use only for Development Panel;** * **Display repositories in the Development Panel**; * corresponding actions are enabled in the **Jigit Development** settings on the global configuration page (available only for Jira administrators). [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Createbranch,Linkbranch,Createcodereview,Linkcodereview) | | **Link branch** | Link an existing Git feature branch from your Git repository to the Jira issue. | To enable any of these functionalities, ensure that: * one of the following properties is enabled when creating a new configuration: * **Use only for Development Panel;** * **Display repositories in the Development Panel**; * corresponding actions are enabled in the **Jigit Development** settings on the global configuration page (available only for Jira administrators). [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Createbranch,Linkbranch,Createcodereview,Linkcodereview) | | **Create code review** | Initiate the code review creation within Jira. | To enable any of these functionalities, ensure that: * one of the following properties is enabled when creating a new configuration: * **Use only for Development Panel;** * **Display repositories in the Development Panel**; * corresponding actions are enabled in the **Jigit Development** settings on the global configuration page (available only for Jira administrators). [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Createbranch,Linkbranch,Createcodereview,Linkcodereview) | | **Link code review** | Link an existing Git code review from your Git repository to the Jira issue. | To enable any of these functionalities, ensure that: * one of the following properties is enabled when creating a new configuration: * **Use only for Development Panel;** * **Display repositories in the Development Panel**; * corresponding actions are enabled in the **Jigit Development** settings on the global configuration page (available only for Jira administrators). [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Createbranch,Linkbranch,Createcodereview,Linkcodereview) | | **Webhooks** | Bidirectional communication between the Jigit plugin and the Git system: updates come into the plugin as soon as the Git system sends the notification, and Jigit has a configuration that can handle it. | To configure, navigate to **Global settings** and select**Enable webhook support** . [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Webhooks) | | **GitHub DependaBot alerts** | Review and address GitHub DependaBot vulnerabilities directly from your project in Jira. | It can only be set on the Jira project-level configuration page within the Security configurations tab. [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-GitHubDependaBotalerts) | | **GitHub Advanced Security integration** | Review and address Azure DevOps GitHub Advanced Security vulnerabilities directly from your project in Jira. | It can only be set on the Jira project-level configuration page within the Security configurations tab. [Learn more](https://help.moveworkforward.com/JIGIT/how-to-integrate-jigit-with-azure-devops-security-.md) | | **Gerrit code review integration** | Link Gerrit changesets and reviews with your Jira issues. | To configure, navigate to the **Gerrit** tab on the global configuration page (available only for Jira administrators) and enable the integration. [Learn more](https://help.moveworkforward.com/JIGIT/features-overview#Featuresoverview-Gerritcodereviewintegration) | | **Activity report** | View git activity reports in Jigit. | To view Git Activity reports in Jigit you need to setup it on the project level. [Learn more](https://help.moveworkforward.com/JIGIT/how-to-activate-and-view-git-activity-reports-in-j.md). | ## Configuration details ### Commit indexation To disable Commit indexation, select the **Use Only for Development Panel** when creating a new configuration or editing the existing one: 1. Go to the **app configuration** page on the global or project level. 2. Navigate to the **Configurations**tab. 3. Click on **Add new configuration** or **Edit**for existing configuration. 4. Select the **Use Only for Development Panel.** 5. After specifying all the necessary parameters, click the **Ok**button to save it. ![Screenshot 2024-05-14 at 1.42.17 PM.png](https://help.moveworkforward.com/__attachments/a_8dbb3d52512ce9d12186b0c8f161d42882dfcba564f61fa3cffa2c0f05577841/Screenshot%202024-05-14%20at%201.42.17%E2%80%AFPM.png?cb=3c82d33c51ddeb440f7ebd0210c52827) More information here: [Jigit Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Configuration), [Jigit Development Panel](https://help.moveworkforward.com/JIGIT/get-started-guide-for-the-jira-end-user#GetstartedguidefortheJiraenduser-JigitDevelopmentPanel). ### Pull-request indexation To enable pull-request indexation, one of the following properties should be checked: **Use only for Development Panel** or **Index pull-requests in repositories** or **Display repositories in the Development Panel.** 1. Go to the **app configuration** page on the global or project level. 2. Navigate to the **Configurations**tab. 3. Click on **Add new configuration** or **Edit**for existing configuration. 4. Select the **Use only for Development Panel** or **Index pull-requests in repositories** or **Display repositories in the Development Panel.** 5. After specifying all the necessary parameters, click the **Ok**button to save it. ![Screenshot 2024-05-14 at 1.42.17 PM.png](https://help.moveworkforward.com/__attachments/a_8dbb3d52512ce9d12186b0c8f161d42882dfcba564f61fa3cffa2c0f05577841/Screenshot%202024-05-14%20at%201.42.17%E2%80%AFPM.png?cb=3c82d33c51ddeb440f7ebd0210c52827) ![Screenshot 2024-05-14 at 1.47.32 PM.png](https://help.moveworkforward.com/__attachments/a_1d4c08cd411d9d5d6f5590e3acbe7591cabf35149aac63ee6a5dfd7ce74bbee8/Screenshot%202024-05-14%20at%201.47.32%E2%80%AFPM.png?cb=0bd7bceefbf314700000f72fbb2312ac) If it is selected**Use only for Development Panel** or **Display repositories in the Development Panel,** pull requests will be visible in the Jigit tab and the Jigit development panel on the Jira issue view screen: ![Screenshot 2024-05-14 at 2.50.32 PM (2).png](https://help.moveworkforward.com/__attachments/a_5113110099fe522eb31b53ecb4ec9cac999e725403df08921f349808f131d05c/Screenshot%202024-05-14%20at%202.50.32%E2%80%AFPM%20(2).png?cb=a11ed3b349411eb99aca439eb9ebb559) If it is selected**Index pull-requests in repositories**, pull requests will be visible along with commits in the Jigit tab on the Jira issue view screen : ![Screenshot 2024-05-14 at 2.50.22 PM.png](https://help.moveworkforward.com/__attachments/a_e0fb7e17c26fb195fbcc0b5385d1bc583e4f00b09d46eba8be04a60bec0b7ccc/Screenshot%202024-05-14%20at%202.50.22%E2%80%AFPM.png?cb=d1d15cbf18fd94c00b1a91acbe05498e) More information here: [Jigit Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Configuration), [Jigit Development Panel](https://help.moveworkforward.com/JIGIT/get-started-guide-for-the-jira-end-user#GetstartedguidefortheJiraenduser-JigitDevelopmentPanel). ### Branch indexation To enable, ensure that **Use only for Development Panel** or **Display repositories in the Development Panel** parameter is enabled when creating a new configuration or editing the existing one:: 1. Go to the **app configuration** page on the global or project level. 2. Navigate to the **Configurations**tab. 3. Click on **Add new configuration** or **Edit**for existing configuration. 4. Select the **Use only for Development Panel** or **Display repositories in the Development Panel.** 5. After specifying all the necessary parameters, click the **Ok**button to save it. ![Screenshot 2024-05-14 at 1.42.17 PM (1).png](https://help.moveworkforward.com/__attachments/a_63a8cdbb7e1559411bb3dc0af55ba0bbf667d2d271f5a5aa9ffac666e355948d/Screenshot%202024-05-14%20at%201.42.17%E2%80%AFPM%20(1).png?cb=3c82d33c51ddeb440f7ebd0210c52827) ![Screenshot 2024-05-14 at 2.55.01 PM (1).png](https://help.moveworkforward.com/__attachments/a_900c69f02db759583e374089d3db8dd9631b3142159a488fbfda317ee1c1e074/Screenshot%202024-05-14%20at%202.55.01%E2%80%AFPM%20(1).png?cb=4f6e71a7224715bd7825a712e39b6a4b) More information here: [Jigit Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Configuration), [Jigit Development Panel](https://help.moveworkforward.com/JIGIT/get-started-guide-for-the-jira-end-user#GetstartedguidefortheJiraenduser-JigitDevelopmentPanel). ### Smart commits To enable, ensure that **Smart commits** is enabledand **Smart commits period** is indicated when creating a new configuration or editing the existing one: 1. Go to the **app configuration** page on the global or project level. 2. Navigate to the **Configurations**tab. 3. Click on **Add new configuration** or **Edit**for existing configuration. 4. Select the **Smart commits** and specify the **Smart commits period**. 5. After specifying all the necessary parameters, click the **Ok**button to save it. ![Screenshot 2024-05-14 at 2.57.15 PM (1).png](https://help.moveworkforward.com/__attachments/a_1696c8dcf5e8957059403124d6aa052b76c98a8949f4c39e9bb47a5b9f704109/Screenshot%202024-05-14%20at%202.57.15%E2%80%AFPM%20(1).png?cb=930b9e6c32b4396bd81f7a79df1488d5) ![Screenshot 2024-05-14 at 2.57.44 PM (1).png](https://help.moveworkforward.com/__attachments/a_5641175d8a79afc72c64be272e75d1217852ca19885c718ccd43ce7b5c731928/Screenshot%202024-05-14%20at%202.57.44%E2%80%AFPM%20(1).png?cb=2b0ebf740cf488ccf31037b302eab8ff) More information here: [Jigit Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Configuration), [Smart commits](https://help.moveworkforward.com/JIGIT/get-started-guide-for-the-jira-end-user.md#Smart-commits). ### Create branch, Link branch, Create code review, Link code review To enable any of these functionalities, the configuration should have **Use only for Development Panel** or **Display repositories in the Development Panel** selected, and the corresponding action should be chosen in the Jigit Development settings: When creating a new configuration or editing the existing one: 1. Go to the **app configuration** page on the global or project level. 2. Navigate to the **Configurations**tab. 3. Click on **Add new configuration** or **Edit**for existing configuration. 4. Select the **Use only for Development Panel** or **Display repositories in the Development Panel.** 5. After specifying all the necessary parameters, click the **Ok**button to save it. ![Screenshot 2024-05-14 at 1.42.17 PM (2).png](https://help.moveworkforward.com/__attachments/a_0114636654074d030d85e25bde2773a1da7c99324c90d86902b9621089020e62/Screenshot%202024-05-14%20at%201.42.17%E2%80%AFPM%20(2).png?cb=3c82d33c51ddeb440f7ebd0210c52827) ![Screenshot 2024-05-14 at 2.55.01 PM (1).png](https://help.moveworkforward.com/__attachments/a_900c69f02db759583e374089d3db8dd9631b3142159a488fbfda317ee1c1e074/Screenshot%202024-05-14%20at%202.55.01%E2%80%AFPM%20(1).png?cb=4f6e71a7224715bd7825a712e39b6a4b) Enable necessary actions in the**Jigit Development settings**(available only for Jira administrators): 1. Go to the **Global Configuration** **page**. 2. Navigate to the **Settings** tab and click the **Jigit Development**. 3. Go to **Enable actions for**and select the actions you need. ![Screenshot 2024-05-14 at 3.08.54 PM (1).png](https://help.moveworkforward.com/__attachments/a_556a5255ede09f112fee4253e67951a7c667644522b50583fdbd2af24dc90fba/Screenshot%202024-05-14%20at%203.08.54%E2%80%AFPM%20(1).png?cb=ab801b4f9091c9b8230ddca4222b7d2a) More information here: [Jigit Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Configuration) [Jigit Development Panel](https://help.moveworkforward.com/JIGIT/get-started-guide-for-the-jira-end-user#GetstartedguidefortheJiraenduser-JigitDevelopmentPanel) [How to create a pull or merge request in Jira using the Jigit app?](https://help.moveworkforward.com/JIGIT/how-to-create-a-pull-or-merge-in-jira-using-the-ji.md) [How to create a feature branch in Jira?](https://help.moveworkforward.com/JIGIT/how-to-create-a-feature-branch-in-jira.md) [How to link the branch to the Jira issue?](https://help.moveworkforward.com/JIGIT/how-to-link-the-branch-to-the-jira-issue.md) ### Webhooks To enable **Webhook support**: 1. Go to the **Global Configuration** **page**. 2. Navigate to the **Settings**tab. 3. Enable **Webhooks support** and provide the**Webhook secret**. ![Screenshot 2024-05-20 at 10.25.35 AM.png](https://help.moveworkforward.com/__attachments/a_63fa8ea7af3d5017232e76a5777e7cbea5d0ab01bc2a16bf99733e9281a6ec52/Screenshot%202024-05-20%20at%2010.25.35%E2%80%AFAM.png?cb=22ecdc97ea68667048a8a0efc887afa9) More information here: [How to configure webhooks with Jigit](https://help.moveworkforward.com/JIGIT/how-to-configure-webhooks-with-jigit) ### GitHub DependaBot alerts Create configuration within **GitHub security alert configurations**tab on the project-level configuration page. 1. Go to the **Project Settings** of the Jira project you want to set up GitHub DependaBot alerts for. 2. Click on **Jigit Plugin Config**app on the left sidebar. 3. Navigate to the **GitHub security alert configurations**tab and create a new configuration. ![Screenshot 2024-05-14 at 3.24.08 PM (2).png](https://help.moveworkforward.com/__attachments/a_24aa524a7249f8e5c00c03fdde05db6b55228fb61fa8ef9a8fb5e24cf0f3c7ce/Screenshot%202024-05-14%20at%203.24.08%E2%80%AFPM%20(2).png?cb=f76e041e539bbfae993fada24a888153) More information here: [How to integrate Jigit with GitHub Dependabot](https://help.moveworkforward.com/JIGIT/how-to-setup-github-dependabot-with-jigit.md) ### Gerrit code review integration To configure Gerrit code review integration: 1. Go to the **Global Configuration** **page**. 2. Navigate to the **Gerrit**tab. 3. Create a new configuration by clicking on the **Add**button. 4. After specifying all the necessary parameters, click the **OK**button to save the new rule. ![Screenshot 2024-05-20 at 2.14.16 PM.png](https://help.moveworkforward.com/__attachments/a_7efbab4d7245e0a2e9afd1d3de85042d987675e62ace9a5bd5b5c37ab8fb8c34/Screenshot%202024-05-20%20at%202.14.16%E2%80%AFPM.png?cb=aaa01b61567645f03df3e0cf35f6f7c9) More information here: [Gerrit Code Review](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Gerrit-Code-Review) *Updated* : 2024-12-03 --- language: "en" --- # General Information ## End User License Agreement ## Privacy Policy ## Security practices ## Security Bug Bounty [Jigit - Jira GitHub \& GitLab integration](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview) is enrolled on the Bug Bounty program. More information can be found here ## Security Self Assessment Questionaire [Jigit - Jira GitHub \& GitLab integration](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview) is part of the Move Work Forward Atlassian Marketplace Partner app portfolio. Move Work Forward provides all required answers to Atlassian annually. More details can be found here *Updated* : 2023-05-19 --- language: "en" --- # Get Started Get started guides for the Jira administrators and Jira end-users. * [Get started guide for Jira administrator](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md) * [Get started guide for the Jira end user](https://help.moveworkforward.com/JIGIT/get-started-guide-for-the-jira-end-user.md) * [Get started with Jigit GitHub/GitLab integration REST APIs](https://help.moveworkforward.com/JIGIT/get-started-with-jigit-github-gitlab-integration-r.md) * [Feature comparison of Jigit vs Git Integration for Jira vs DVCS](https://help.moveworkforward.com/JIGIT/feature-comparison-of-jigit-vs-git-integration-for.md) --- language: "en" --- # Get started guide for Jira administrator Get started guide for Jigit - GitHub, GitLab, Azure DevOps integration for Jira On-Premise administrators. ## About Jigit [Jigit is a Jira application for Jira On-Premises (Server and Data Center)](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview) that provides an**issue view tab**, which displays all commits and pull/merge requests referencing the issue key from connected Git systems like GitHub, GitLab, Azure DevOps and Gerrit Code Review. Azure DevOps integration available since version 9.03.23. The **development panel** displays issue-related branches, permits the creation of new feature branches, pull or merge requests, mapping branches to the Jira issue directly from the issue view screen. Jigit gives you a convenient way to collect commits and pull requests from GitLab and GitHub. Jigit queries Git servers using their public **REST APIs** and saves commits and pull requests into a Jira database, so no code access is required. The app uses only the **commit history**. The App does not have access to your source code. It doesn't clone your repositories, so no disk space is used to store sources. It uses REST APIs to query data. By the way, have you seen our [GitLab and Confluence integration](https://marketplace.atlassian.com/apps/1216286/gitlab-for-confluence?hosting=cloud&tab=overview)? ## Video course A good place to start is to review [Jigit Tutorials video course](https://youtube.com/playlist?list=PLSsd6IAGxHntfy2fTz6d9Kg4ZtY3TqG_L&si=fwvL8UJKpQT3CiP_). ## Jigit Configuration You can start the Jigit plugin configuration for integration with GitHub, GitLab, Azure DevOps and Gerrit platforms in multiple ways - Access tokens, OAuth apps, Basic Auth, etc. [How to generate Personal Access Token in GitHub?](https://help.moveworkforward.com/JIGIT/how-to-generate-personal-access-token-in-github.md) [How to generate Access Token in GitLab?](https://help.moveworkforward.com/JIGIT/how-to-generate-access-token-in-gitlab.md) [How to generate Personal Access Token in Azure DevOps?](https://help.moveworkforward.com/JIGIT/how-to-create-azure-devops-personal-access-token.md) Once your **Access Token** is ready, you can move to the integration set-up. First of all, you have to add a new configuration on the configurations tab: 1. Move to the **Jira Administration** section (**"gear"** button in the right corner of the navigation menu). 2. Navigate to the **Manage app** page and find our application **Jigit Plugin Config** on the left sidebar. 3. From the **Configurations** tab, click ![image-20240720-120415.png](https://help.moveworkforward.com/__attachments/a_6755f57c29c124a4d0c7571f8906ca31f8a5b4a1ad601999a94a927e0be8b3fd/image-20240720-120415.png?cb=d956c3dd42509fadce99de0d8fe44e19) . 4. After specifying all the necessary parameters, click the **Save**button. 5. The**Test connection** button lets you check the connection and communication between Jira and the linked GitHub,GitLab or Azure DevOps instances. ![image-20240720-120808.png](https://help.moveworkforward.com/__attachments/a_9d6abe0ca587e688d97e51c18e362a213fa8f5e1ff0c222fba0596a2f0947c76/image-20240720-120808.png?cb=c31d60ada2d9e092e32106ff03c5dcfe) Below you can find a short definition of each parameter you have to specify in the modal window that appears in front of you: | **Parameter** | **Definition** | |--------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Select Git system to connect with` | specify the Git system for your connection; Azure DevOps, GitLab, GitLab 8 or earlier, GitHub or GitHub App | | `Use only for Development Panel` | select to prevent commits from being indexed. Development Panel on issue view screen will only display branches and pull-requests. | | `Index pull-requests in repositories` | Available since 4.12.19 Jigit can index, pull and merge request messages; when this parameter is enabled, the integration will actively monitor and index the pull requests in your repositories. The pull or merge request title should contain the **issue key** . For instance, *DEV-123 added support for pull requests indexing for GitLab and GitHub.* | | `Display repositories in the development panel` | the visibility of repositories to be able to сreate a branch, link a branch to the Jira issue, and сreate a code reviewusing [Jigit Development Panel](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Development-Panel). | | `Smart commits` | Available since 3.04.01 allows you to enable or disable the use of smart commits; Jigit support for **smart commits** for transition: if you write the commit message in the form #in-progress (hash, status name without spaces), the issue will be transitioned to the status **In Progress** . The smart commits work similarly to the [Bitbucket Smart Commits](https://confluence.atlassian.com/bitbucketserver/use-smart-commits-802599018.html#UseSmartCommits-transitionWorkflowtransitions). It works only if your workflow does not have any mandatory fields on transition. | | `Add git activities as issue comments` | when enabled, Git activities, such as commits, pushes, and merges, are automatically added as comments to associated Jira issues. After a commit is added, the operation can't be reversed. Comment stays there even if plugin is **deleted**. | | `Host` | enter a host of your Git server; it can be [*https://github.com*](https://github.com/), [*https://gitlab.com*](https://gitlab.com/), [https://dev.azure.com](https://dev.azure.com/) or your instance on the GitLab server (for example, [*https://my.own.gitlab:8443*](https://my.own.gitlab:8443/)*).* Also, you can create a **GitHub app** and use it to get access to Github, the app needs to have the necessary permissions. **Important:** After you change GitHub app permissions you need to make sure it was reinstalled on the organization level and the permission-change was accepted by the organization admin/owner. | | `Path to group/repository` | path; it can be either a **repository name** or a **repository group** (GitLab) or **organisation**(GitHub) name; a repository name usually consists of two parts and is displayed in the query string of a browser. For example, in the URL the name of the repo is *gitlab-org/gitlab-ce* and the group name is *gitlab-org*. For Azure DevOps integration, in the URL the name of the repo is *Move-Work-Forward/BTR%20project/_git/MWF* and the group name is *Move-Work-Forward* or *Move-Work-Forward/BTR%20project*. Also, you have to specify the content type inside a given path: **repository** or a **group** of repositories (drop-down opposite the path) Subgroups are only working with **GitLab**. | | `Default Branch` | The default branch of your GitHub or GitLab repository that will be used for integration with Jira, by default it is indicated `master` branch; Jigit indexes git commits from the default branch and then from the others. When you use Test Connection action, it uses the default branch and the first accessible repository to check the connectivity. | | `Access Token` | authentication token you created before that allows an individual user to authenticate and access GitHub resources. Service accounts are often used for this purpose. | | `What branches to index` | a way of branch indexing: * **All branches** inside a repository * **Branch mask** helps filter and match specific branches in your GitHub or GitLab repository. * **Selected branches** The aim is to decrease the number of API calls if this number is limited (it's actually for [https://github.com](https://github.com/), for example). If you select the "all branches" option, Jigit makes API calls to check whether there have been new git commits since the last check (even to stale branches). | | `Jira Projects to associate configurations with` | Jira project names list where the commits and pull requests should be visible | | `Smart commits period` | lets you to specify a time duration after which smart commits should be ignored | | `Override indexation settings` | allows you to manually change the default settings for indexation | | `Commit indexing window` | a time period within which commits are indexed and associated with Jira issues | | `Commit request timeout` | the maximum amount of time allowed for making a request to retrieve commit information from the connected GitHub or GitLab repository; this parameter is used when Jigit calls the git server by HTTP API, and if the timeout is exceeded during a call the add-on stops the indexing of a repository. If you see **ConnectException: Connection timed out** in JIRA logs, you can increase this value to overcome it. *Default and recommended - 10 seconds.* | | `Sleep` | the duration of a pause or delay between consecutive requests made by the integration to the connected GitHub or GitLab repository *Default and recommended - 10 seconds.* | | `Each` | frequency at which the integration checks for new commits or changes in the connected GitHub or GitLab repository *Default and recommended -* *100* *requests.* | | `Integration name` | indicate an alias/name for your configuration which will be displayed on the configurations tab page; an alias should be unique; you can't add two configurations with the same alias. | | `Enable` | enables the configuration to allow indexation | Here is a**quick demo video** of connecting [Jira to GitLab using the Jigit app.](https://marketplace.atlassian.com/apps/1216325/advanced-microsoft-teams-jira-connector?hosting=datacenter&tab=overview) Once the configuration has been created, you can start using the app on the Jira issue view screen. The other configurations are optional to make your integrations more streamlined and efficient. ## Settings The **Settings** tab allows Jira administrators to configure and customize the integration settings. Those settings include: * **General Settings**: default settings for users and projects across the entire Jira instance * **Request Settings**: adjust indexation request configurations * **Jigit Development**: configure Development Panel parameters After specifying the necessary parameters, remember to click the **Save settings** button. ![image-20240720-122946.png](https://help.moveworkforward.com/__attachments/a_2fc748b4608f55685a247b033629556d707b801e830ba2402667b03db92053e2/image-20240720-122946.png?cb=77fbacb49fd6ebb1bc54294d61b368a4) Below is a short definition of each parameter of the **General settings** section. | **Parameter** | **Definition** | |-----------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Projects to hide Jigit` | Jira projects where the Jigit tab is not visible in the activity section and the Jigit Development panel is not available. No projects chosen means **available everywhere**. | | `Projects to show Jigit` | Jira projects where the Jigit tab is visible in the activity section and the Jigit Development panel is available. No projects chosen means **available everywhere**. | | `Issue types to hide Jigit` | Issue types where the Jigit tab is not visible in the activity section and the Jigit Development panel is not available. No issue types specified means **available everywhere**. | | `Issue types to show Jigit` | Issue types where the Jigit tab is visible in the activity section and the Jigit Development panel is available. No issue types specified means **available everywhere**. | | `URL pattern` | allows you to define the URL to which the Jigit can connect; by default, all URLs are allowed, but the Jira administrator can use `jira-jigit-plugin.url.pattern` environment variable to set the URL pattern, which restricts the URL entered for all new configurations. For example, -Djira-jigit-plugin.url.pattern="[https://github.com\|https://gitlab.com"](https://github.com%7Chttps//gitlab.com%22). | | `Remove non-ASCII symbols from commits and pull-requests` | ensures that any non-ASCII symbols or characters in commit messages and pull request titles are removed or replaced with ASCII equivalents. It is required for some DB engines that do not handle non-ASCII characters. **Non-ASCII symbols** refer to characters that are outside the standard ASCII character set, which includes characters such as letters, numbers, and basic punctuation marks commonly used in the English language. Examples of non-ASCII symbols include special characters, diacritical marks, emojis, or characters from other languages and scripts. | | `Commit indexation interval` | Specify the interval in seconds between periodical commit indexation | | `Pull request indexation interval` | Specify the interval in seconds between periodical pull request indexation | | `Enable webhook support` | Allows the use of webhooks from the Git system allowing for more responsive feedback. Use the URL specified in your webhook which follows the format JIRA_BASE_URL/plugins/servlet/jigit/webhook | | `Webhook secret` | A secret password defined to validate the payload signature when connecting the webhook | Below is a short definition of each parameter of the **Request settings** section. | **Parameter** | **Definition** | |--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Commit indexing window` | a time period within which commits are indexed and associated with Jira issues. Note: Leave empty for an unlimited window | | `Commit Request Timeout` | the maximum amount of time allowed for making a request to retrieve commit information from the connected GitHub or GitLab repository; this parameter is used when Jigit calls the git server by HTTP API, and if the timeout is exceeded during a call the add-on stops the indexing of a repository. If you see **ConnectException: Connection timed out** in JIRA logs, you can increase this value to overcome it. *Default and recommended - 10 seconds.* | | `Sleep` | the duration of a pause or delay between consecutive requests made by the integration to the connected GitHub or GitLab repository *Default and recommended - 10 seconds.* | | `Each` | frequency at which the integration checks for new commits or changes in the connected GitHub or GitLab repository *Default and recommended -* *100* *requests.* | Below is a short definition of each parameter of the **Jigit Development** section. | **Parameter** | **Definition** | |-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Patterns of repositories to show` | Specifies the comma-separated patterns of repositories to show in Jigit Development | | `Patterns of repositories to hide` | Specifies the comma-separated patterns of repositories to hide in Jigit Development | | `Branch indexation interval` | Specify the interval in seconds between periodical branch indexation | | `User PAT usage in development panel` | user should create their own Personal Access Token and associate it with existing configurations. Thereafter all integrations with GitHub are performed on users behalf. * User will only see their available repositories * Branches \& pull requests created by the user will list them as author | | `GitHub advanced development panel` | show pull request details including reviews and build status. This can work with User PAT usage in dev panel if set. All this data is loaded in real-time which requires more calls to GitHub when the user sees the ticket | | `Do not load Jigit Dev Panel data by default` | when enabled, the development panel won't load be default, and will only be shown when triggered by the user clicking the 'Load development panel' option. | | `New branch pattern` | Specify the naming convention for new branch creation. The following placeholders can be used: {issue-key}, {issue-summary}, {issue-description}, {issue-type}, {user-name} | | `Enable actions for` | show the corresponding options in the Development panel | ## GitHub DependaBot integration If you want to see the GitHub DependaBot vulnerabilities in the Jira project and link them to a new or existing Jira issue, check out - [How to integrate Jigit with GitHub Dependabot](https://help.moveworkforward.com/JIGIT/how-to-setup-github-dependabot-with-jigit.md) ## Gerrit Code Review **Jigit - GitHub, GitLab, Azure DevOps integration for Jira** supports integration with **Gerrit Code Review**, allowing you to link Gerrit changesets and reviews with your Jira issues. This enables you to seamlessly bridge the gap between code reviews and project management in Jira. When the Gerrit is integrated with Jira using Jigit, it shows the data in a separate Jira issue view tab. ![image-20220216-150324.png](https://help.moveworkforward.com/__attachments/a_c18bb9d138de87ff5f6652d956aea37789b18d3d1c01570862cc67d4cd2f549a/image-20220216-150324.png?cb=a39442a0b9d02778c0af74a362a45338) ### Configuration To configure **Gerrit Code Review** navigate to the **Gerrit** tab on the Global configuration page and enable the integration. Since version 6.15.04 multiple instances of Gerrit Code Review tool are supported. Create a new configuration rule following the next steps: 1. Click the Add button in the bottom right corner of the Configuration tab. 2. After you have specified all the necessary parameters click on the **Ok**button to save the new rule. 3. The**Test Connection** button allows you to check the connection and communication between Jigit and the connected **Gerrit Core Review** account. ![MicrosoftTeams-image (10).png](https://help.moveworkforward.com/__attachments/a_1d48cad7b205b1920f4a5349775a2fb4c3c19210356a892e9cc498afb350f6af/MicrosoftTeams-image%20(10).png?cb=72a0623738c026a4992a7b80fc3e3426) ![image-20230525-081833.png](https://help.moveworkforward.com/__attachments/a_b9cfa84f414fe04b98a16185ac9b215ac0d2698e808982fdbf2ac6e5736427b5/image-20230525-081833.png?cb=61406b1fe12df8014c8c5f31586abce2) Please, read the definitions of each parameter you have to specify in the **modal window** that appeared in front of you: | **Parameter** | **Definition** | |----------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Name` | the name of your configuration rule | | `Enabled` | refers to whether the integration with Gerrit Code Review is enabled or disabled | | `URL` | URL to Gerrit Server instance allows the Jigit app to connect to your Gerrit and retrieve information about changesets, reviews, and other related data. | | `User` | username or account that the Jigit app will use to authenticate and interact with your Gerrit to access the REST APIs | | `Password` | the password or authentication token associated with the user account specified in the "User" setting | | `Gerrit Project` | the specific project or repository in your Gerrit instance that you want to integrate with Jigit app. Here you can restrict search results only to particular Gerrit Project. This parameter is **optional**. No projects are chosen means that the app will search for all changes in Gerrit. | | `Use only for Development panel` | restricts the Jigit plugin to only be used within the Development panel of Jira | | `Add Gerrit development panel` | display status information into the development panel on the Jira issue view screen | | `Projects to hide Gerrit` | the list of Jira projects where to hide Gerrit information | | `Projects to show Gerrit` | the list of Jira projects where to show Gerrit information | | `Search for issue in` | the list of items where to search for the Jira issue key mentioned | | `Hashtags` | the Gerrit changes with the given hashtags appear first in the result. Hashtags might increase amount of request to get the changes. | | `Monitoring window` | the time interval during which Jigit will actively monitor and retrieve updates from the Gerrit | ### Hashtags [How to see Gerrit high priority code reviews in the Jigit Development panel](https://help.moveworkforward.com/JIGIT/how-to-see-gerrit-high-priority-code-reviews-in-th.md) ### Circuit Breaker With the **circuit breaker** ,you can make Jira more stable when Gerrit is unavailable or having issues. The circuit breaker monitors the connectivity and responsiveness of integrated services such as Jira, GitHub, and GitLab. It keeps track of the success or failure rate of requests made to these services. ![image-20230525-061020.png](https://help.moveworkforward.com/__attachments/a_a0de74f84701ffdb297cf27b82ccf05c58f8e54ff2d49e7baf365376d2656243/image-20230525-061020.png?cb=347e7dabcf29ff63c68d98216d769d62) Below are the parameters' definitions that help you tweak the **circuit breaker** according to your system. We recommend starting with the default ones before your start tweaking those. | **Parameter** | **Definition** | |--------------------------------|--------------------------------------------------------------------------------| | `Failure rate threshold` | percent of failures to stop querying Gerrit | | `Monitoring window` | period in seconds during which requests are monitored | | `Minimum requests` | minimum requests to calculate state | | `Slow request threshold` | requests which are longer than interval are treated as slow | | `Slow requests rate threshold` | percent of slow requests to stop querying Gerrit | | `Silence interval` | if problems are detected than plugin stops querying Gerrit for target interval | ### Gerrit JQL functions In Jigit - Jira GitHub \& GitLab integration, the **JQL (Jira Query Language)** function is available for filtering changes in Gerrit. Jigit leverages the **Gerrit REST API** to interact with Gerrit and perform JQL-based queries. This function is experimental and may cause the performance issues if used with unbound scope. Please provide your feedback. ### Gerrit performance * Gerrit information is queried when the Jira issue is rendered, and the data is placed in the Cache. Default cache invalidation is 3 minutes; it is configurable. * Gerrit information is not stored in the Jira database and lives only in the memory in Jira Cache. * Gerrit integration uses **ETags**to cache the results. The current cache configuration is 1000 items of each size of up to 5MB. Available since 5.07.27/6.07.27 ## Jigit Development Panel Available since 5.02.23 ![image-20230822-191635.png](https://help.moveworkforward.com/__attachments/a_b45e0ad48b420f4802a05ccdd6ea43f27e5b8df4c0282e13b47f0089a41b62e1/image-20230822-191635.png?cb=3c9d4ee7b3b5d6e6599d998bf9cb20a4) The Jigit development panel displays the statuses of GitHub checks The**Jigit Development Panel** is a panel on the issue view screen where you can create new branches in the configured git connections and see related branches. The Jigit Development Panel provides information about **branches** and **pull requests** where the **issue key** is featured in the name. For this feature to work you need to make sure the **Personal Access Token** used in the configuration has the correct **permissions**enabled to allow the create-branch operation. To configure the **Jigit Development Panel**displaying, you need to: 1. Navigate to the**Settings**tab on the Configuration page. 2. Select the **Jigit Development** drop down 3. You can find an overview of each parameter to configure in the [Jigit Development Section](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Dev-Section). 4. Click on the **Save settings**button to save the updated configurations. To be able to **сreate or link a branch** to Jira issue, and **сreate a code review** using Jigit Development Panelyou need to enable parameter `Display repos in the development panel` during [Jigit Plugin Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Plugin-Configuration). ![image-20240729-122945.png](https://help.moveworkforward.com/__attachments/a_89f9e9fd1e014f14074fb7b483902b63d40723f1a108c5c2a52bab70c97d9ecc/image-20240729-122945.png?cb=905d297f9938be968a3dc567e573fe3b) Please watch this demo video for more details about**the Jigit Development panel**. ### Require user Personal Access Token (PAT) Jira administrators can configure Jigit to use the user's PAT instead of an admin-configured PAT. Admin can control this in the global settings (since version 8.08.22). ![image-20240729-123123.png](https://help.moveworkforward.com/__attachments/a_9e737667bb3f7dc2c10a031259ac80467939de5112a73ded569e903b840b85ca/image-20240729-123123.png?cb=e8b2471d847d8be0885ba5efc256b1b9) The Jira end-users will need to visit their personal settings and configure PATs. ![image-20230822-192154.png](https://help.moveworkforward.com/__attachments/a_bbdc73d338a259335ddc266e02f4d12d4656e73e8c248bebb6ce10dbfd013632/image-20230822-192154.png?cb=c828a1ccc245c65f86992318e7fd0de8) The benefits of having users configured PATs are: * increased security, the users can only see what they see in the Git system * spread the load on GitHub using different PATs. Git systems usually have limits of API calls per PAT, the more PATs are used, the better. ## REST APIs [Get started with Jigit GitHub/GitLab integration REST APIs](https://help.moveworkforward.com/JIGIT/get-started-with-jigit-github-gitlab-integration-r.md) By the way, have you seen our [GitLab and Confluence integration](https://marketplace.atlassian.com/apps/1216286/gitlab-for-confluence?hosting=cloud&tab=overview)? ## Support of GitHub/GitLab webhooks [How to configure webhooks with Jigit](https://help.moveworkforward.com/JIGIT/how-to-configure-webhooks-with-jigit.md) ## How-tos [How-To Guides](https://help.moveworkforward.com/JIGIT/how-to-guides.md) By the way, have you seen our [GitLab and Confluence integration](https://marketplace.atlassian.com/apps/1216286/gitlab-for-confluence?hosting=cloud&tab=overview)? ## Debugging and troubleshooting Please follow this how-to article - [How to enable debug-level logging for Jigit: Jira GitHub GitLab integration?](https://help.moveworkforward.com/JIGIT/how-to-enable-debug-level-logging-for-jigit-jira-g.md) *Updated* : 2024-09-30 --- language: "en" --- # Get started guide for the Jira end user The get started guide for the end user of Jigit - GitHub, GitLab, Azure DevOps integration for Jira helps people use the app on the Jira issue view screen. This guide is for [Jigit - GitHub, GitLab, Azure DevOps integration for Jira](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview) available on Atlassian Marketplace for Jira Server and Data Center. ## About Jigit [Jigit is a Jira application for Jira On-Premises (Server and Data Center)](https://marketplace.atlassian.com/apps/1217129/jigit-jira-github-gitlab-integration?hosting=datacenter&tab=overview) that provides an**issue view tab**, which displays all commits and pull/merge requests referencing the issue key from connected Git systems like GitHub, GitLab, Azure DevOps and Gerrit Code Review. Azure DevOps integration available since version 9.03.23. The **development panel** displays issue-related branches and permits creating a new feature branch directly from the issue view. Jigit allows you to collect commits and pull requests from GitLab, GitHub and Azure DevOps. Jigit queries Git servers using their public **REST APIs** and saves commits and pull requests into a Jira database, so no code access is required. The app uses only the **commit history**. ![image-20240720-140949.png](https://help.moveworkforward.com/__attachments/a_ff50e1fb783abe6894ab1b08c9a4e1b66e8745959d2a0f420f2d15e5c5421e87/image-20240720-140949.png?cb=c2dbd81bbefe74091bdd53daba950f0b) The App does not have access to your source code. It doesn't clone your repositories, so no disk space is used to store sources. It uses REST APIs to query data. **This guide assumes that your Jira or project administrator finished the Jigit application configuration and connected to one or multiple Git systems.** Please reach out to your Jira administrator if you need any assistance or learn more in our guide: [Get Started guide for Jira administrator](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md) ## Video course A good place to start is to review [Jigit Tutorials video course](https://youtube.com/playlist?list=PLSsd6IAGxHntfy2fTz6d9Kg4ZtY3TqG_L&si=fwvL8UJKpQT3CiP_). ## Jigit tab The Jigit tab on the issue view screen displays information related to commits, merge requests or pull requests associated with a **particular Jira issue** with the help of the Jigit app. This includes details such as the status of the merge request or pulls request, the branch being merged, and any associated comments or details. ![image-20240720-141209.png](https://help.moveworkforward.com/__attachments/a_204888a2da1833787b73b44c42b1f7814ba6a516cc06eb051c0c7d06609ce5cc/image-20240720-141209.png?cb=431068853140a33e9d2d7930006cec06) ### Associate Git entities with Jira issues Once the Jira administrator configures the repository, you must associate **Git branches, commits,** **pull** and **merge requests** with Jira issues. Jigit uses **Jira issue keys** (for example, **TP-1**) to link Git entities to specific issues: 1. In your Git commit messages**,** the pull and merge request **summary** or**title field** includes the **Jira issue key(s)** that the Git entity relates to. The **branches** to be shown must contain the issue key in the **branch name**. 2. A Git entity can contain **more than one** issue key. In this case, it will be displayed on the tab of every mentioned issue. 3. Once the **Git entity** is created and saved, you should see the information related to it on the **Jigit tab**. The issue key shouldmatch **exactly**. For instance, the following**Git-commit** messages will be linked to the Jira issue **TP-1**: ![image-20230526-093225.png](https://help.moveworkforward.com/__attachments/a_ba8fb352a8596eb3ff40ec8cfed6a024d2646b6613ad7aba365ef6887d04d14b/image-20230526-093225.png?cb=ad82502fcdc296342bcb7d3280d75772) **Jira issue view** ![image-20230526-093812.png](https://help.moveworkforward.com/__attachments/a_8f8bc5f99035ea4056441dfde47583c4faa1abd0ab7c7c6fb460561b3eccf498/image-20230526-093812.png?cb=6ec78146d5e678e6145ba40c89ea986a) ### Smart commits Available since 3.04.01 **Smart commits** are special commit messages that allow you to perform specific actions in Jira through your Git commit messages. Jigit supports smart commits for **transitions**. This feature will be available if only it is enabled in the configuration settings on the **Configuration page** by the Jira administrator. To find out, please contact your Jira administrator. For example, if you write the commit message in the form **#in-progress** (hash, status name without spaces), the issue will be transitioned to the status **In Progress**. The smart commits work similarly to the [Bitbucket Smart Commits](https://confluence.atlassian.com/bitbucketserver/use-smart-commits-802599018.html#UseSmartCommits-transitionWorkflowtransitions). ## Comments tab Besides the **Jigit Tab,** Git activities could be displayed on the **Comments**tab (if the Jira admin selects to use the comment tab, not a standalone Jigit tab). This feature will be available if only it is enabled in the configuration settings on the**Configuration page** by the Jira administrator. To find out, please contact your Jira administrator. The app does not provide the mapping between Github/Gitlab/Azure DevOps and Jira users. As we need to specify the **user** on which behalf we add the comment, we use **Assignee** or the **Creator** (if the issue is not assigned) as the **comment author**. ![image-20240730-211635.png](https://help.moveworkforward.com/__attachments/a_d1569bb9a67c20896f0a0873d6235f925ada60268e4b2a660efbaec166479ffa/image-20240730-211635.png?cb=7dec651fbb280e673bf44daa767c1fac) **GitHub App Jigit Integration** is the alias of the configuration created by Jira administrator. Its link navigates to the relevant GitHub/GitLab/AzureDevOps repository. ![image-20240730-211800.png](https://help.moveworkforward.com/__attachments/a_d58bcc13cedd5cee3894449a6a5eefa0ce0357fa5728f24ea51d6641268f953d/image-20240730-211800.png?cb=ba8bc31dcf1c5b5da18171896c1ab939) ## Jigit Development Panel Available since 5.02.23 **Jigit Development Panel** is available on the issue view screen where you can see related branches and create a new branch in the configured git connections. The Jigit Development Panel provides information about **branches** and **pull requests** whose names include the **issue key**. This feature will be available if only it is enabled on the **Global configuration page** by the Jira administrator. To find out, please contact your Jira administrator. The Jigit development panel is shown **on the right side** of the Jira issue view and displays: * branches count in a repository; * pull requests with the status; * the action buttons: * to create the feature branch; * link branch; * create a code review. ![image-20230822-191635.png](https://help.moveworkforward.com/__attachments/a_74f9f57f2aa72175f8380d4f3fc747a03e302857ba36c3eab104dae7a70681e4/image-20230822-191635.png?cb=3c9d4ee7b3b5d6e6599d998bf9cb20a4) To **сreate branch** , **link branch** to Jira issue, and **сreate a code review** using Jigit Development Panelyour **Jira administrator** needs to enable parameter `Display repos in the development panel` during [Jigit Plugin Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Plugin-Configuration). To find out, please contact your **Jira administrator**. ### Create feature branch Instead of switching between different tools or command-line interfaces, you can initiate the **feature branch**creation process within Jira, saving time and effort. To create a feature branch using the Jigit Development Panel, you can follow these steps: 1. Go to the **Jira issue** corresponding to the branch you want to create. 2. On the **Jigit Development Panel** , click the **Create branch** button to open a dialogue window. 3. In the dialogue, select the desired branch from which you want to create a new branch and the branch name (should include the **issue key** to be displayed on the Jira issue view screen). 4. Confirm the selection and the branch will be created and visible on **Jigit Development Panel**. Remember to use the issue key otherwise, the newly created branch won't be visible on the development panel. ![image-20240729-125545.png](https://help.moveworkforward.com/__attachments/a_10666d526d01d94cfd5542f6143b0bf07655d6f5a73c1c2d805b8237408c8886/image-20240729-125545.png?cb=5de7c65bdd7c6d0953aac37be3db2f04) ![image-20240729-125941.png](https://help.moveworkforward.com/__attachments/a_eea36176e47d83a638f7d34072993f30de971e22721367583712c7560cec8102/image-20240729-125941.png?cb=41fca0db42e88ab963348aa9e3f9efae) ### Link branch **Link branch** allows you to link an existing Git feature branch from your **Git repository** to the Jira issue. The purpose of the**Link branch**option is to associate an existing branch in your repository with the specific Jira issue you are working on. This linkage provides visibility and context within Jira, allowing you and your team members to easily access and track the branch associated with the issue. To link a branch to a Jira issue using the Jigit Development Panel, you can follow these steps: 1. Go to the **Jira issue** corresponding to the branch you want to link. 2. On the **Jigit Development Panel** in the Jira issue view, click on the **Link branch** option to open a dialogue window. 3. In the dialogue, select the desired branch from your Git repository to link to the Jira issue. 4. Confirm or save the selection; the branch will be linked to the Jira issue. ![image-20240729-130127.png](https://help.moveworkforward.com/__attachments/a_e90c8fa2543ebf5a5b0309558410baf1d2341399eb36ba6c217027058db3928f/image-20240729-130127.png?cb=0da82370f3bab89067fe1cc5e7700a74) ![image-20240729-130203.png](https://help.moveworkforward.com/__attachments/a_01f6a7a1f171c7b319caea34581f7c31bf5a0db43bbc5415953d3f691be79ae1/image-20240729-130203.png?cb=b550ebeaed878cd66aacd9312186d498) ### Create a code review By creating a code review using the Jigit Development Panel, developers can quickly identify any issues or potential problems with their code and make the necessary changes before merging it into the main branch. This improves the code's quality and helps prevent bugs and other issues from occurring later on. To create a code review using the Jigit Development Panel, you can follow these steps: 1. Go to the **Jira issue** corresponding to the code review you want to create. 2. On the **Jigit Development Panel** , click the **Create a code review**button to open a dialogue window. 3. In the dialogue, select the desired branch from which you want to create a new **code review** , thetarget branch and the title (should include the **issue key** to be displayed on the Jira issue view screen). 4. Click on the **Ok** button, and the code review will be created and visible on **Jigit Development Panel**. ![image-20240729-130401.png](https://help.moveworkforward.com/__attachments/a_215526a86afa461a7933f831d3775fbf2e8da1d48bf560569e37aea842995061/image-20240729-130401.png?cb=3a347b7b0765df022aed11acd130925e) ![image-20240729-130515.png](https://help.moveworkforward.com/__attachments/a_a04c3f3c59571dd9475c344e61cfdb847743a58120cfb24ac15a5f485485d8ff/image-20240729-130515.png?cb=c2f0d77948e6a48537110ef319ffe841) ### Set up a personal access token for the Jigit Development Panel To configure the personal access tokens - visit the user profile settings and manage/create them in the Jigit section. ![image-20240729-131928.png](https://help.moveworkforward.com/__attachments/a_11d648aba1653f9d4ed8e6bf38a1a9fe9af60f893584ca0f2e758e65e52ebf3a/image-20240729-131928.png?cb=dc30bd1b3ae7c08a1a1febf656ad0b4d) ## GitHub DependaBot integration If you want to see the GitHub DependaBot vulnerabilities in the Jira project and link them a new or existing Jira issue, check out - [How to integrate Jigit with GitHub Dependabot](https://help.moveworkforward.com/JIGIT/how-to-setup-github-dependabot-with-jigit.md) ## Gerrit Code Review tab Jigit - GitHub, GitLab, Azure DevOps integration for Jira supports integration with **Gerrit Code Review** , allowing you to link Gerrit changes and reviews with your Jira issues. Gerrit change should include the **issue key** to be displayed in the Gerrit tab. This feature will be available if only it is enabled on the **Global configuration page** by the Jira administrator. To find out, please contact your Jira administrator. This enables you to seamlessly bridge the gap between code reviews and project management in Jira. When the Gerrit is integrated with Jira using Jigit, it shows the data in a separate Jira issue view tab. ### Associate Gerrit Code Review entities with Jira issues After completing the configuration and establishing a connection between Jira and your Gerrit instance by the Jira administrator, you can start linking Gerrit changes with Jira issues: 1. In Gerrit, include the Jira issue key in the commit message or change description when creating or updating a code change. 2. The Gerrit integration plugin will automatically detect the Jira issue key in the commit message or change the description and establish the link between the Gerrit change and the corresponding Jira issue. 3. Details about the Gerrit change will be visible on the **Gerrit tab,** and the **Gerrit panel will be**shown on the right side of the Jira issue view. ![MicrosoftTeams-image (22) upd.png](https://help.moveworkforward.com/__attachments/a_ae25139f6538bf1a1e7236546016171052c8aafe0993572b11f7210675ea92b5/MicrosoftTeams-image%20(22)%20upd.png?cb=a45553141e5cefa5b86536eac4b0a89c) **Jira** **issue view** ![MicrosoftTeams-image (11)upd.png](https://help.moveworkforward.com/__attachments/a_2b5b31f20dce29cf6e4fb08a605e0dc3d190382c0747e955cd143eceb16e2016/MicrosoftTeams-image%20(11)upd.png?cb=162683361ea576eddd1ef899196df363) ### Gerrit JQL functions In Jigit - GitHub, GitLab, Azure DevOps integration for Jira, the **JQL (Jira Query Language)** function is available for filtering changes in Gerrit. Jigit leverages the **Gerrit REST API** to interact with Gerrit and perform JQL-based queries. The JQL function narrows down the **Jira issue search** result by limiting the number of commits associated with an issue. In the search query, you need to use the command `gerritStatus`. Examples of search queries you can modify to meet your needs: * issue in gerritStatus(PROJECT_KEY, STATUS): `issue in gerritStatus("TEST", "open") issue in gerritStatus("TEST", "abandoned") issue in gerritStatus("TEST", "new") issue in gerritStatus("TEST", "merged")` * issue in gerritStatus(PROJECT_KEY, STATUS, CHANGES_AFTER_DATE): `issue in gerritStatus("TEST", "closed", "``2022``-10-25")`, where date means "since"/"after" ## Troubleshooting If you have issues with Jigit, you must involve your Jira administrator. *Updated* : 2024-09-20 --- language: "en" --- # Get started with Jigit GitHub/GitLab integration REST APIs Get started with Jigit GitHub/GitLab integration REST APIs. ## Basic information **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations` Request headers: * **Content-Type** : `application/json` Response headers: * **Content-Type** : `application/json` Authentication depends on Jira configuration - Basic or Bearer. REST endpoints do not return a token but replace it with `"xxxxxxx"` ## Get configurations **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations` **HTTP verb** : `GET` **Response:** [ { "id":3, "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":"xxxxxxx", "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST", "TP" ], "devPanelOnly":false, "level":"GLOBAL", "supportDevelopmentPanel":true }, .... ] ## Get Jira project configurations **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations?projectKey=TEST` **HTTP verb** : `GET` **Response:** [ { "id":3, "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":"xxxxxxx", "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "projectKey": "TEST", "level":"PROJECT", "supportDevelopmentPanel":true }, .... ] ## Get configuration by ID **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations/{ID}` **HTTP verb** : `GET` **Response:** { "id":3, "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":"xxxxxxx", "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "projectKey": "TEST", "level":"PROJECT", "supportDevelopmentPanel":true } ## Save configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations` **HTTP verb** : `POST` **Payload:** { "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", //GitLab, GitLab8, GitHub, GitHubApp "token":"MY_TOKEN", "repoType":"SingleRepository", //SingleRepository, GroupOfRepositories "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ "dev" ], "enabled":true, "requestTimeout":10000, //ms "sleepTimeout":10000, //ms "sleepRequests":100, //count "branchStrategy":"ALL", //ALL, MASK, SELECTED "includeSubgroups":false, "sleepTo":0, // internal usage only "smartCommitEnabled":true, "commitsPeriod":28800000, // days in ms "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":null, "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "projectKey": null, //must be set only if level=PROJECT "level":"GLOBAL", // GLOBAL, PROJECT "supportDevelopmentPanel":true } **Response:** { "id":3, "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ "dev" ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":null, "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "level":"GLOBAL", "supportDevelopmentPanel":true } ## Update configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations/{ID}` **HTTP verb** : `PUT` **Payload:** { "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":"xxxxxxx", "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "projectKey": "TEST", "level":"PROJECT", "supportDevelopmentPanel":true } **Response:** { "id":3, "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":"xxxxxxx", "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "projectKey": "TEST", "level":"PROJECT", "supportDevelopmentPanel":true } ## Delete configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations/{ID}` **HTTP verb** : `DELETE` **Response:** { "id":3, "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":"xxxxxxx", "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "projectKey": "TEST", "level":"PROJECT", "supportDevelopmentPanel":true } ## Disable/Enable configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations/{ID}/activity?enabled=false` **HTTP verb** : `PUT` **Response:** { "id": 3, "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":"xxxxxxx", "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "projectKey": "TEST", "level":"PROJECT", "supportDevelopmentPanel":true } ## Change authentication credentials **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations/{ID}/authentication` **HTTP verb** : `PUT` **Payload:** { "token": "NEW_TOKEN" // optional, "privateKey": "NEW_PRIVATE_KEY" // only for GitHub App "appId": "app_id" // only for GitHub App } **Response:** { "id": 3, "repoName":"test configuration", "serverUrl":"https://github.com", "serviceType":"GitLab", "token":"xxxxxxx", "repoType":"SingleRepository", "repositoryId":"org/repository", "defaultBranch":"master", "branches":[ ], "enabled":true, "requestTimeout":10000, "sleepTimeout":10000, "sleepRequests":100, "branchStrategy":"ALL", "includeSubgroups":false, "sleepTo":0, "smartCommitEnabled":true, "commitsPeriod":28800000, "commentCommitEnabled":true, "appId":"", "repositoryPattern":"", "privateKey":"xxxxxxx", "indexPullRequests":true, "indexAllBranches":false, "developmentEnabled":true, "indexDaysLimit":30, "projectKeys":[ "TEST" ], "devPanelOnly":false, "projectKey": "TEST", "level":"PROJECT", "supportDevelopmentPanel":true } *Updated* : 2024-02-19 --- language: "en" --- # Help & Support ## Contact information 📑 Please create a support request [here](https://moveworkforward.atlassian.net/servicedesk/customer/portal/1). 👨‍💻 Schedule a demo call [here](https://calendly.com/getally/dc-video-support?back=1). *Updated* : 2023-05-30 --- language: "en" --- # How does Jigit ensure proper performance? Here you can find performance considering for Jigit. Includes information about frequency of indexing and requests to the 3rd party system. Jigit respects the API rate limits. When it gets throttled, it delayed the new requests. Jigit App uses **GitLab/GitHub REST APIs** to index commit messages against Jira issues. Those APIs can be throttled. As a result, the indexing should be spread over time to smooth the load. Otherwise, Git systems will reject requests of Jigit. It is done in the following way: * There is a scheduled task that runs every 2 minutes (can be changed with `moveworkforward.jigit.index.interval`) * It checks the head commit and indexes it. Indexing works the following way: * extracts Jira issue keys; * stores those in the database together with the commit information; * adds to the internal queue the next commit (if it was not indexed before); * sleeps every X requests to the GitLab (configurable). * If a commit had been indexed, the whole index process for that branch/repo combination stops * The scheduled task is run from **1 Data Center node**(in the case of Jira Data Center multi-node deployment). ## Throttling related parameters ![image-20210304-022602.png](https://help.moveworkforward.com/__attachments/a_a60bcb6849d9a2d32a7899b76121d311775ba3f28b50adbe81195567e7ddfddf/image-20210304-022602.png?cb=5af7fa5c97f821f08c63d18651de6f81) * `Commit Request Timeout` - tells for how long the connection should be open to calling the GitHub/GitLab API before it times out.*Default and recommended - 10 seconds.* * `Sleep `- the time Jigit will sleep between request batches (controlled by parameter each X request). *The default and recommended value is 10.* * `Each X requests `- is the number of requests in each request branch before the sleep. *The default and recommended value is 10.* **The logic behind those values is:** GitHub has a limit of 5000 requests per hour per agent (Jigit is an Agent in this case), which is around 83 per minute. With the default settings, Jigit may execute 60 requests per minute, which is close, but still below 83. **Other performance considerations:** * when the App runs the first time, it may take a while to index an old repository with multiple commits; * there is a scheduled task per each configuration rule. ## Official Rate limits by systems GitHub - GitLab - On-Premise instances could have those settings tweaked. *Updated* : 2023-06-02 --- language: "en" --- # How does Jigit store the data? Here is the description of the data stored by Jira GitLab and GitHub integration. ## What data is stored? The app only stores the data it needs to display on the **Issue View tab**which currently shows the commit details and light diff information. The Jigit App does not access the source code. ## Table structures ### Commit table | **Column name** | **Column type** | **Description** | |-----------------|-----------------|-------------------------------------------------------------| | `commitSha1` | `String` | The commit reference hash. Primary Key. | | `title` | `String` | The title of the commit (usually the message). | | `author` | `String` | The author of the commit in the Git system (GitHub/GitLab). | | `createdAt` | `Date` | The date the commit was created. | | `repoGroup` | `String` | The optional parent grouping of the commit (group/project). | | `repoName` | `String` | The name of the repository the commit belongs to. | | `branch` | `String` | The name of the branch the commit was made. | | `isFirstCommit` | `Boolean` | Is this the first commit? | ### Issue commit table | **Column name** | **Column type** | **Description** | |-----------------|-----------------|------------------------------------| | `issueKey` | `String` | The issue key. Primary Key. | | `commitSha1` | `String` | The reference to the commit table. | ### Commit diff table | **Column name** | **Column type** | **Description** | |-----------------|-----------------|-------------------------------------------------------------------------------------------------------------------------| | `commitSha1` | `String` | The reference to the commit table. Primary Key. | | `oldPath` | `String` | The old path to the file. | | `newPath` | `String` | The new path to the file. | | `actionId` | `Integer` | One of the following actions. ADDED(1, "Added"), MODIFIED(2, "Modified"), RENAMED(3, "Renamed"), DELETED(4, "Deleted"); | ### Queue item table This table is used by the indexer as a processing queue. | **Column name** | **Column type** | **Description** | |-----------------|-----------------|-----------------------------------------------| | `commitSha1` | `String` | The commit hash to process. Primary Key. | | `repoName` | `String` | The name of the repository commit belongs to. | | `branch` | `String` | The name of the branch commit belongs to. | *Updated* : 2023-05-30 --- language: "en" --- # How to activate and view Git Activity reports in Jigit To view Git Activity reports in Jigit, repositories must be added within the Project Settings ## Adding Git Activity Reports Activity Reports are available since version 9.03.39 From your Jira Project, go to the **Project settings** by selecting the cogwheel on the bottom left. From here, select **Jigit Plugin Config** and then the **Git Activity** tab. ![Screenshot 2024-10-25 at 19.05.06.png](https://help.moveworkforward.com/__attachments/a_4ae2e4489020f218ca0b110990b1745d377221785e556d32bf65a9719ad349a4/Screenshot%202024-10-25%20at%2019.05.06.png?cb=0c4860d50cd632deae99bf18ef4a7c8c) ### Configure Git Activity Settings ![image-20241025-182036.png](https://help.moveworkforward.com/__attachments/a_bcaaa576ede85341f9e8b5292be392c0fb177d2fcb7a05fb4f8c734e782898ef/image-20241025-182036.png?cb=5fe067dea110d2df7116b121c6001c53) Below you can find a short definition of the parameters you can specify | **Parameter** | **Definition** | |------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------| | `Repositories` | Specify which repositories are to be included in Git Activity reports | | `Pull requests` | Enable to show pull requests opened and merged during the specified period in Git Activity reports | | `Pull requests statuses` | Enable to include the status of open and inactive pull requests to show in Git Activity reports | | `Inactive pull requests more than` | Specify the number of days since a pull request was last updated for it to be included in the 'Inactive Pull Requests' section of the Git Activity reports | | `Commits` | Enable to show new commits made during the period specified in your Git Activity reports | | `Enable` | Enable Git Activity reports Disabling will remove the Git Activity menu on the left if no other configurations are available | Remember to click the ![image-20241025-185451.png](https://help.moveworkforward.com/__attachments/a_a275ee0e5e9453d4166b87d6644a2965473bf14528e7ada400cc8978d9d6ad44/image-20241025-185451.png?cb=d600b2d53be30f783e9ad6ade286ae67) button after configuring your preferences. If repositories have been selected and Git Activitie reports enabled, you should see ![image-20241025-185132.png](https://help.moveworkforward.com/__attachments/a_fbf272dccc289bc28939d04d5bdf83676c6873602786ffe2e64fa910a0dfb2c6/image-20241025-185132.png?cb=b5c263093083e969cc046f05efc7155d) listed on the menu to the left. ![image-20241025-185223.png](https://help.moveworkforward.com/__attachments/a_1a541c8181a4e54ed10ab1fb222a6a587fa7b99f70c6160404317101de8c7ad7/image-20241025-185223.png?cb=5d36549a07b7e2d8f0747ec82daab7f6) ## Viewing Git Activity Reports Click on**Git Activity** to be brought to the Git Activity page: ![image-20241025-191020.png](https://help.moveworkforward.com/__attachments/a_628ec1318a0f0895feaf318887515ae24673e7ae53b2ef369827b3ae9995071c/image-20241025-191020.png?cb=c96ba5c52f2211a9ec65a250cf699115) Under ***Repository***, you can add or remove repositories to show from those listed during the configuration. ***Period (in days)***allows you to specify the time period (1, 7, 14 or 30 days) for which opened and merged Pull Requests are shown. By clicking the **Arrow** to the left of the listed repositories, it's possible to collapse or expand the relevant repository, as shown below. ![image-20241025-192052.png](https://help.moveworkforward.com/__attachments/a_d4963f43de24b5267d3f383a76579626ca2c6cfd8ea8ffb3474825d6ce42b47e/image-20241025-192052.png?cb=7621cb89a4cbde1f17fb2c4337b36ffc) *Updated:* 2024-10-25 --- language: "en" --- # How to configure personal access token to use with the Jigit Development panel How to configure personal access token to use with Jigit Development panel. Admin and the end user instructions. Make sure you have Jigit 8.08.22 or above installed ## Step-by-step user instructions Please visit your Jira user profile page and find the Jigit section. In the Jigit section, please use the **Add** button to create a new configuration or Actions → Edit on the existing one. ![image-20230822-193342.png](https://help.moveworkforward.com/__attachments/a_0bef0867867bc08e5cc0cd19681e1b9a00b40a7f698498ea37a36f97f179cb5c/image-20230822-193342.png?cb=946f62f1baec265af2e469db18ba166c) Follow the instructions to create, test and save your PAT. It will be used ONLY for the Jigit development panel and stored in your Jira database. ## Step-by-step admin instructions Jira administrators can configure Jigit to use the user's PAT instead of admin-configured PAT. Admin can control this in the global settings. ![image-20230822-192044.png](https://help.moveworkforward.com/__attachments/a_b306de100816b99d0e2763a0f5cd00803c95846f5481d5c364b681607eaab1f5/image-20230822-192044.png?cb=800c576ecf03c03834d0cd0c3ddca700) *Updated* : 2023-08-22 --- language: "en" --- # How to configure webhooks with Jigit ## Webhook support Using Webhooks enables Jigit to know about the new commits and pull requests a few moments after they happen. To configure webhook, you must navigate to **Global settings → Enable webhook support**. ![image-20240111-200745.png](https://help.moveworkforward.com/__attachments/a_07a693b37e6ac85f3d6c5d2fdc980609cbf2d56ea04072e99e02a281ac02334e/image-20240111-200745.png?cb=e9a106ffe73251fbc48291389515436e) When you enable the webhook support you need to ensure that the URL shown is accessible from your Git server(s). **Webhook** URL: JIRA_BASE_URL/plugins/servlet/jigit/webhook ## GitHub webhook event You need to select at least the following events: * branch or tag creation * branch or tag deletion * pull requests * pushes * ![image-20240111-200603.png](https://help.moveworkforward.com/__attachments/a_ec05f8a7e1c7a231c4946e33cc2dcdcc1a2477293f23fbee2ab170f64c711523/image-20240111-200603.png?cb=383a4f19c5e3609b5216cf22b6cca0f2) ![image-20240111-200613.png](https://help.moveworkforward.com/__attachments/a_4eb9b104169e84b564b92a4c5c8feafd5a6170e18ed805c4184a0d7f7f8d9f34/image-20240111-200613.png?cb=e298b48ac69ef2943b8ceaad00b59071) ## Gitlab webhook configuration You need to select at least the following events: * push events (all branches) * merge request events ![image-20240111-200736.png](https://help.moveworkforward.com/__attachments/a_e4dac3984621c10b9e49bceaf026fb026f748723de5d7e5e2b2fb45138fd8313/image-20240111-200736.png?cb=63cee6c0497b8025fb53cbc51c1ec5b7) *Updated* : 2024-01-11 --- language: "en" --- # How to create a feature branch in Jira? Instead of switching between different tools or command-line interfaces, you can initiate the **feature branch**creation process within Jira, saving time and effort. To **сreate or** **link branches** to a Jira issue, and **сreate or link code reviews** using Jigit Development Panelyour **Jira administrator** needs to enable parameter `Display repositories in the development panel` during [Jigit Plugin Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Plugin-Configuration). To enable this, please contact your **Jira administrator**. To create a feature branch using the **Jigit Development Panel**, you have follow the steps: 1. Go to the **Jira issue** that corresponds to the branch you want to create. ![image-20240729-175049.png](https://help.moveworkforward.com/__attachments/a_bc757b3d861eb8eddb05620c871d1a6ed7cdbbcf0dc9e056041973050e96b06c/image-20240729-175049.png?cb=46de54e4b2a61f6f73c310ce539d9f4b) 2. On the **Jigit Development Panel** click on the **Create branch** button, which will open a dialogue window. 3. In the dialogue, select the desired branch from which you want to create a new branch and the branch name (should include the **issue key** to be displayed on the Jira issue view screen). ![image-20240729-175443.png](https://help.moveworkforward.com/__attachments/a_93f8f2227ba135c47e5948064b2bdedeba307d0473088c645d24425eabc8fd19/image-20240729-175443.png?cb=b472b7526e488d5334cd5dd5e186cba5) 4. Confirm the selection and the branch will be created and visible on **Jigit Development Panel**. ![image-20240729-175533.png](https://help.moveworkforward.com/__attachments/a_2aaa6c08682a0de891440020297325261f3ef5459e5fa8c7212d0967d5b57c70/image-20240729-175533.png?cb=cd99ea1986709f23e76ee3a7e1fd45f8) *** ** * ** *** [How to link Git entities to Jira issues?](https://help.moveworkforward.com/JIGIT/how-to-link-git-entities-to-jira-issues.md) [++How to create a pull or merge in Jira using the Jigit app?++](https://help.moveworkforward.com/JIGIT/how-to-create-a-pull-or-merge-in-jira-using-the-ji.md) [How to link the branch to the Jira issue?](https://help.moveworkforward.com/JIGIT/how-to-link-the-branch-to-the-jira-issue.md) *Updated* : 2024-07-29 --- language: "en" --- # How to create a pull or merge request in Jira using the Jigit app? By creating a code review (a pull or merge request) using the Jigit Development Panel, developers can quickly identify any issues or potential problems with their code and make the necessary changes before it is merged into the main branch. This not only improves the quality of the code but also helps to prevent bugs and other issues from occurring later on. To **сreate or** **link branches** to a Jira issue, and **сreate or link code reviews** using Jigit Development Panelyour **Jira administrator** needs to enable parameter `Display repositories in the development panel` during [Jigit Plugin Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Plugin-Configuration). To enable this, please contact your **Jira administrator**. To create a code review using the Jigit Development Panel, you have to follow the steps: 1. Go to the **Jira issue** that corresponds to the code review you want to create. ![image-20240729-174313.png](https://help.moveworkforward.com/__attachments/a_0c9f4a1fc5d2689fb00d3b49f9a16cf3c1b35bd76ca58f9008046df65d0e8414/image-20240729-174313.png?cb=c9fc5d50d064765952abfd719178492a) 2. On the **Jigit Development Panel** click on the **Create code review**button, which will open a dialogue window. 3. In the dialogue, select the desired branch from which you want to create a new **code review** , thetarget branch and the title. ![image-20240729-130401.png](https://help.moveworkforward.com/__attachments/a_61e307a667319d4f3ddf8e06b37f8cfa73dbd98bc9ec257cc5e1944ff68a37d6/image-20240729-130401.png?cb=3a347b7b0765df022aed11acd130925e) 4. Click on **Ok** button and the code review will be created and visible on **Jigit Development Panel** . ![image-20240729-174638.png](https://help.moveworkforward.com/__attachments/a_5ef552dfd0a84dbe6ab2fa1a7281a094b54b14e13585f126e7873f03a1c69cf0/image-20240729-174638.png?cb=a426dc7893586b7502c1cd75316acf78) *** ** * ** *** [How to link Git entities to Jira issues?](https://help.moveworkforward.com/JIGIT/how-to-link-git-entities-to-jira-issues.md) [How to create a feature branch in Jira?](https://help.moveworkforward.com/JIGIT/how-to-create-a-feature-branch-in-jira.md) *Updated* : 2024-07-29 --- language: "en" --- # How to generate Personal Access Token in Azure DevOps? In this short guide, you will find how to create Azure DevOps personal access token. ![:warning:](https://help.moveworkforward.com/__attachments/a_788a529d594fd672579b740bee13557db0bf18f9391b252fc28b853f28c9411b/atlassian-warning?cb=14432459925d605e05cae2605cdfe666) Ensure that the user who will be creating the token is the **Project administrator**. **Edit Subscriptions** and **View subscriptions** permissions are required. Check out this [Microsoft guide](https://learn.microsoft.com/en-us/azure/devops/service-hooks/overview?view=azure-devops#q-what-permissions-do-i-need-to-set-up-a-subscription). ![image-20230510-125354.png](https://help.moveworkforward.com/__attachments/a_9b29693c3e73bf6cdd846539099fad05a81d4e0bdeeb713d0c4a18620f55aab2/image-20230510-125354.png?cb=fe177a761d19f56353235ac8f410cc8b) The following steps will help you create a new **Personal Access Token**: 1. Navigate to the **User Settings**in the right corner of the navigation menu. ![image-20201003-064125.png](https://help.moveworkforward.com/__attachments/a_a2a684e6436488d96edfdf5f0ad38227c40779419de52ab5a4b74e0d5f075c1c/image-20201003-064125.png?cb=6f78ca703373ec1ab0ca38c45a65995b) 2. From the drop-down select **Personal Access Tokens**. 3. Click on the **New Token**button and generate a new personal access token with the following parameters: 1. Organisation:**All accessible organizations** or grant access to the particular **Azure DevOps organisation**. 2. Scopes:**Read\&Write** to the **Code**. **Write** access to the **Code** is required tocreate Azure DevOps branches or pull requests from Jira. If you do not intend to use this functionality, grant **read-only** access. ![image-20240424-164755.png](https://help.moveworkforward.com/__attachments/a_cbc2cddfc95db390766926867aa7759757b630e540531e01ebb5091f2cb637b3/image-20240424-164755.png?cb=7f8aea35e9bbf148bb3804cbc4b790a5) 4. Click on **Create** and copy the token. For your security, it doesn't display again. After obtaining the **Personal Access Token**, we can proceed to connect the instances of Jira and Azure DevOps. *** ** * ** *** [How to set up Azure DevOps integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-azure-devops-integration.md) *Updated* : 2024-04-24 --- language: "en" --- # How to define default repositories in Jigit Defining default repositories is available from version 10.1.6 onwards The Configurations will need to be indexed before the list of repositories will populate 1. Click on the profile picture in the top right, then select **Profile** ![image-20250626-010825.png](https://help.moveworkforward.com/__attachments/a_ace16d84f8a8029c3406bf79cf85df723af880d46fa4315cd1e5225b7deab34a/image-20250626-010825.png?cb=4a904bf345fd055d80efab7b0f6fbf61) 2. Scroll down to **Jigit personal settings** ![image-20250627-013906.png](https://help.moveworkforward.com/__attachments/a_693c2f23ecaef5402f5eeff197fd39ff55806a023f4db67ce4d6b3ff8e9d11b7/image-20250627-013906.png?cb=ff025f84a7ae23cb036952e04cc04cd6) 3. Clicking the drop down arrow will show the list of indexed repositories ![image-20250627-014158.png](https://help.moveworkforward.com/__attachments/a_80fadee1262f0b94f7443bcad2dbc9f542272d40bd1bc84ad4922d5b15a06355/image-20250627-014158.png?cb=60c5548f484e6f32242cda8835341957) It is also possible to search for specific repositories. Note: the search field is **case sensitive** ![image-20250627-014437.png](https://help.moveworkforward.com/__attachments/a_21809e9f417f3f7c76e479084707904f43601815684c2bbd6eb17fbae92924d6/image-20250627-014437.png?cb=87d4c61abe76808c744bd735e89d048a) 4. Select the default repository to be used for branch creation and click **Save settings** ![image-20250627-014757.png](https://help.moveworkforward.com/__attachments/a_3007bbb10bfbae4b73c587b7021dd57cffa03c01dea82cb74dbdf5790a23bb5c/image-20250627-014757.png?cb=d78011cb5d5d9271b26cdbd79fa3e74b) 5. Now when creating a branch, the repository will pre-populate with the chosen default repository ![image-20250627-014959.png](https://help.moveworkforward.com/__attachments/a_b1895404e699d3207cc12465c3a2a5d98799226bbd0c4a83df15f1108261fb22/image-20250627-014959.png?cb=a23b4724740a063e367a59c0df472e72) 6. By listing multiple repositories, it will configure the order they populate when using the drop down during branch creation. ![image-20250627-015207.png](https://help.moveworkforward.com/__attachments/a_6efeee96483bfc0d35e08f43871b1da37aa6504819373228a9bc5a894c831e11/image-20250627-015207.png?cb=ef5aeba97361ef924a3ce29bf362252c) ![image-20250627-015321.png](https://help.moveworkforward.com/__attachments/a_a532be9388c0b2dea32f8ead1faed75b5e192c1c7ac60fd2f20ef999cb19ceec/image-20250627-015321.png?cb=56438509b2d3fe2c745b208022e37bf9) *Updated:* 2025-06-26 --- language: "en" --- # How to enable debug-level logging for Jigit: Jira GitHub GitLab integration? **Debugging**allows you to identify and resolve issues or bugs. When users encounter unexpected behaviour, errors, or performance issues, debugging helps pinpoint the root cause and provides valuable insights for resolving the problem. ## How to Enable Debugging If you need to debug the app, please: 1. Add `jigit` with the **DEBUG log level** inthe **Logging and Profiling** section: **JIRA ADMINISTRATION → System → Logging and profiling → Configure logging level for another package**. ![image-20230601-072616.png](https://help.moveworkforward.com/__attachments/a_b323fea7aed00a6ec0c39a3c189b005b7fdcd63fb41fa6c0b0b7eb1e0adbde5b/image-20230601-072616.png?cb=dc510e496731ae97df2ea6019070d881) 2. Reproduce the issue you are having. 3. Send us the **support zip or Jira log file only** . Navigate to the **Audit Log**section to export it. ![image-20230601-073138.png](https://help.moveworkforward.com/__attachments/a_ed7bc126d11b122986e799df1be4b76ca0381a3679875e0ddf479fac9bd163b7/image-20230601-073138.png?cb=a6209e08ab5f2638fd1dcc52390b611e) ## How to Create a Support Zip File 1. From the **System** Tab of your Jira Administration, go to **Troubleshooting and support tools** from the menu bar on the left 2. Go to the **Create support zip** tab ![image-20240725-184111.png](https://help.moveworkforward.com/__attachments/a_fa5c83c23a1698463e2cc4beff5d7f0ea040cbc878595a5cd82aab035b261f45/image-20240725-184111.png?cb=c89bac679c17f51186609e24141886e4) 3. Click the ![image-20240725-184521.png](https://help.moveworkforward.com/__attachments/a_7956357092816e54f540a9d78fcaeb31537499e632bcc4afd43b320db319ba18/image-20240725-184521.png?cb=c69da30c44f3cfd2e03744e922f9be69) button so that only Jira application logs are included to avoid sending unnecessary information. ![image-20240823-190247.png](https://help.moveworkforward.com/__attachments/a_ac258f9c25fbf917923ef125995f10689375c0e91062c249e3433997184e33e2/image-20240823-190247.png?cb=96076abd8e1c0c88a01e2cdb599ec1ba) 4. Click on ![image-20240725-184820.png](https://help.moveworkforward.com/__attachments/a_1324fa5f101f0ecb8a05ea9786f32a6dd3827100fa62811bed17cea9cee173ce/image-20240725-184820.png?cb=6f4ab819d3366bdb0a54de55bcda8a89) to generate the support zip file 5. Download the support zip to finalize the process ![image-20240725-185006.png](https://help.moveworkforward.com/__attachments/a_6df5cec64cddef8182c17c387c967a8250dd576c5c138c580d0fcb94bcb53475/image-20240725-185006.png?cb=eff7046f9fedd4831246d45fc3212963) *Updated* : 2024-07-25 --- language: "en" --- # How to enable GitHub.com OAuth GitHub.com OAuth allows you to set up GitHub authentication, which takes precedence over configuration mappings, removing the need to individually map GitHub configurations 1. To begin, setup a Github configuration ![image-20250704-004237.png](https://help.moveworkforward.com/__attachments/a_afde139394dd3a8b474b43bcb59855b0e681d24650c0882a07f0b2daef74b6e2/image-20250704-004237.png?cb=668697346f1d9291c0b5bffb58e0f364) A guide to setting up GitHub configurations can be found here: [https://mwf-help.atlassian.net/wiki/spaces/JIGIT/pages/2391474177/How+to+set+up+GitHub+or+GitLab+integration?atlOrigin=eyJpIjoiYjU0ZjA4ZDNjN2QxNGRhODg4MzU4YzNlMGJlYTQyNDIiLCJwIjoiYyJ9](https://help.moveworkforward.com/JIGIT/how-to-set-up-github-or-gitlab-integration.md) 2. Go to the **Settings** tab and expand the **Supported Git systems** section ![image-20250704-021435.png](https://help.moveworkforward.com/__attachments/a_a1df9350db3fd830321098ce634e7d860e7cd62cddc84ace263ca2e388289af7/image-20250704-021435.png?cb=1a2afda522a14bb5ca49bfd04f7de774) 3. Under **Supported Git systems** , choose **Github** , then **Enable GitHub.com oAuth** ![image-20250704-021746.png](https://help.moveworkforward.com/__attachments/a_6d837d0ae3cbc5acd868a3f23502734ea6c0f0ac6505fbbdb749d2172e7cb0f2/image-20250704-021746.png?cb=5a13d06451432f9d3c29d2fa97723177) 4. Enter the **GitHub Client ID** , **GitHub secret** and **GitHub redirect URI** ![image-20250704-023910.png](https://help.moveworkforward.com/__attachments/a_05b3ec8559d07a4d73d618d0d60c423ccf74b73edccecb7e8ac7c7db4ff01c12/image-20250704-023910.png?cb=f8698cefa42a032ebaffbb9426d57b1f) A guide on creating an OAuth app can be found here: 5. Don't forget to **Save settings** ![image-20250704-023728.png](https://help.moveworkforward.com/__attachments/a_4fed7d6cce315b179efc97a5ff64c68ecd2bfb53f12460cffc2c7eea20479def/image-20250704-023728.png?cb=db0794d7a88d8ea21c3893fd9640c71b) 6. Next, from the same **Settings** section go to the **Jigit Development** section ![image-20250704-004332.png](https://help.moveworkforward.com/__attachments/a_9a7dd232dbf2b687660062210478a0915b2e2ac3413ac3b0d6120d5290532b9d/image-20250704-004332.png?cb=726a9a4091d911cf9140fb3edd8bb1db) 7. Under **User PAT usage in development panel**, a user token must be available, so choose one of the following 3 options: 1. **Use user token if set** ![image-20250704-004502.png](/__attachments/a_8d51196da44d25627aeb508e2ab09a0b126b6c5cb5721feea91bc80a9c2210b5/image-20250704-004502.png?cb=55cba4d87cba0464a2d532ccbc1f4733) 2. **User token is required for actions** ![image-20250704-004558.png](/__attachments/a_119ed5328b09853ce58dd18a72d7a91993d60b30afe462a9a310476ed479a8d5/image-20250704-004558.png?cb=6ed0443f6fb314a5cd1d1cf99aecb136) 3. **User token is required** ![image-20250704-004617.png](/__attachments/a_4d322245294e77594be7f9055fb8d2eedc63ed92dda5f1f47f25f2537e402688/image-20250704-004617.png?cb=9aeb41325cfc62155d183d4351320b48) Save your settings once again. 8. From the top right, select the profile icon, then go to **Profile** ![image-20250704-012345.png](https://help.moveworkforward.com/__attachments/a_2ee970fe85382d9ac404299044cc355ff6d10ce6a6d8f896fb4c69248a540628/image-20250704-012345.png?cb=1b50420e56b861c0ba712a6ec756506e) 9. Scroll down and select the **Jigit configuration mappings** tab, then click **Connect to GitHub.com** ![image-20250704-015924.png](https://help.moveworkforward.com/__attachments/a_b508c7131f09c7143b0de7cf9608a5fe87d21f812cec33d5035212d24293d9ed/image-20250704-015924.png?cb=6418b0e324ac702ff31234899fca7d6c) 10. Authorize the OAuth app to access the account ![image-20250704-025713.png](/__attachments/a_80e87ee4e7cd0fd7d5055d8dab6136413c26b92c84acab521ad57204bf732c58/image-20250704-025713.png?cb=f00f1834175411c45bf93fe44ec3d679) If you wish to wish to subsequently remove Oauth, go back to Jigit configuration mappings section from your Profile and click Disconnect from [GitHub.com](http://github.com/) ![image-20250704-030046.png](/__attachments/a_bdab1c6bedfcc976535c88a927604b1314f75662ba05330992ec680a17fac009/image-20250704-030046.png?cb=71ee24b32497a296fd69194a76731734) *Updated* : 2025-07-03 --- language: "en" --- # How to generate Access Token in GitLab? To connect your Jira and GitLab instances, you need to obtain an **Access Token**. GitLab provides options to use **GitLab project access token** or **GitLab personal access token**. ## Create a project access token To generate a Personal Project Token in GitLab, you can follow these steps: 1. On the top bar, select the **Main Menu** and **Projects**section. Find your project. 2. On the left sidebar, open the **Settings** dropdownand select **Access Tokens**. 3. Provide a name for your access token in the **Token name** field. This will help you identify its purpose later. The token name is visible to any user with permission to view the project. 4. Enter an expiry date for the token. 5. Select a role for the token. 6. Select the desired scopes for your access token based on the permissions you need. Jigit uses only **API** scope to read commits' information. 7. Click on the **Create project access token** button at the bottom of the page. ## Create a personal access token To generate a Personal Access Token in GitLab, you can follow these steps: 1. Click on your **profile avatar** in the top right corner and select **Edit profile**from the dropdown menu. 2. In the left sidebar, navigate to **Access Tokens**. 3. You may be prompted to re-enter your GitLab account password for security purposes. 4. Provide a name for your access token in the **Token name** field. This will help you identify its purpose later. 5. Provide an **expiration date** for the token. 6. Select the desired scopes for your access token based on the permissions you need: 1. **read_api**scope to read commits' information. 2. **API scope** to read commits' information and create Git entities using Jigit. 7. Click on the **Create personal access token** button at the bottom of the page. 8. After you click the button, GitLab will generate a personal access token for you. Make sure to copy and securely store the token since you won't be able to see it again. ![12345.png](https://help.moveworkforward.com/__attachments/a_906703ec362560db7fb64e4311d0cce7c880700d4fc6a138857266aa6b733d72/12345.png?cb=0cf9e9075eeb4f2861f139b76eec6433) Alternatively, you can read about how to create an **Access Token** in GitLab documentation: * [GitLab project access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html); * [GitLab personal access token](https://docs.gitlab.com/ce/user/profile/personal_access_tokens.html). *** ** * ** *** [How to set up GitHub or GitLab integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-github-or-gitlab-integration.md) *Updated* : 2023-06-02 --- language: "en" --- # How to generate Personal Access Token in GitHub? To connect Jira and GitHub instances, we need to create a **Personal Access Token (PAT)**. ## Step-by-step instruction We recommend using a service user for this configuration. The following steps will help you create a new GitHub **Personal access token**: 1. Click on your **profile picture** in the top-right corner of the page and select **Settings**from the dropdown menu. 2. In the left sidebar, click on **Developer settings** and navigate to the **Personal access tokens**section. 3. Click on the **Generate new token** button. You need to generate one of these two types of tokens: 1. fine-grained token (repo-scoped); 2. classic token (for general use). ![image-20230525-095950.png](/__attachments/a_7c8f9f63351ac29e63567190db0cb68ac4db362d0bb1abe04637e3f5b7c1343b/image-20230525-095950.png?cb=cf2835f94d3cd9e98b15c2720a47289c) 4. Provide the required details: 1. a **name** or descriptive **note**for the token to help you remember its purpose and 2. the **expiration date**; 3. for fine-grained tokens, you must select the **resource owner;**usually, it is an organization. 5. Select the desired **scopes**for the token. Scopes determine the access and permissions granted to the token. 6. Once you've selected the scopes, click on the **Generate token** button. 7. GitHub will generate a new **Personal Access Token** for you. Make sure to copy the token and keep it secure, as it will not be shown again. Alternatively, you can read [here](https://github.blog/2013-05-16-personal-api-tokens/) about how to create an **Access Token** in GitHub. ## Permissions scopes If you create **fine-grained tokens** , the required minimum of **Repository permissions** are: * Contents → Access: Read and write. * Metadata → Access: Read-only. * Pull requests → Read and write. ![image-20230427-102056.png](https://help.moveworkforward.com/__attachments/a_da368d1cb3b5939aab1b62d1a8b60dd0c3c4f832fcaf12702786f23c12fac9d6/image-20230427-102056.png?cb=d38a3d4579d27d9d4e7a0858ca4e2795) If you create **classic tokens,** the required is: * **repo** scope to read commits. ![Screen Shot 2021-03-06 at 18.09.34.png](https://help.moveworkforward.com/__attachments/a_8d7a39fa0bce7459cdb28608e2ba8c71c372fb079c1d4fdf0f09e020a2298f8a/Screen%20Shot%202021-03-06%20at%2018.09.34.png?cb=2fc3e9d96d0981901be00d0ef7a94b4f) Once you have the **Personal Access Token,** you can proceed with Connection Jira and GitHub instances. *** ** * ** *** [How to set up GitHub or GitLab integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-github-or-gitlab-integration.md) *Updated* : 2023-06-02 --- language: "en" --- # How-To Guides How to guides for Jigit - GitHub, GitLab, Azure DevOps integration for Jira * [How to generate Personal Access Token in GitHub?](https://help.moveworkforward.com/JIGIT/how-to-generate-personal-access-token-in-github.md) * [How to generate Access Token in GitLab?](https://help.moveworkforward.com/JIGIT/how-to-generate-access-token-in-gitlab.md) * [How to set up GitHub or GitLab integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-github-or-gitlab-integration.md) * [How to enable GitHub.com OAuth](https://help.moveworkforward.com/JIGIT/how-to-enable-github-com-oauth.md) * [How to set up GitHub App integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-github-app-integration.md) * [How to generate Personal Access Token in Azure DevOps?](https://help.moveworkforward.com/JIGIT/how-to-create-azure-devops-personal-access-token.md) * [How to set up Azure DevOps integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-azure-devops-integration.md) * [How to set up Gerrit Code Review integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-gerrit-code-review-integration.md) * [How to link Git entities to Jira issues?](https://help.moveworkforward.com/JIGIT/how-to-link-git-entities-to-jira-issues.md) * [How to link Gerrit changes to Jira issues?](https://help.moveworkforward.com/JIGIT/how-to-link-gerrit-changes-to-jira-issues.md) * [How to create a pull or merge request in Jira using the Jigit app?](https://help.moveworkforward.com/JIGIT/how-to-create-a-pull-or-merge-in-jira-using-the-ji.md) * [How to create a feature branch in Jira?](https://help.moveworkforward.com/JIGIT/how-to-create-a-feature-branch-in-jira.md) * [How to link the branch to the Jira issue?](https://help.moveworkforward.com/JIGIT/how-to-link-the-branch-to-the-jira-issue.md) * [How does Jigit store the data?](https://help.moveworkforward.com/JIGIT/how-does-jigit-store-the-data.md) * [How does Jigit ensure proper performance?](https://help.moveworkforward.com/JIGIT/how-does-jigit-ensure-proper-performance.md) * [How to utilize Jigit for enterprises](https://help.moveworkforward.com/JIGIT/how-to-utilize-jigit-for-enterprises.md) * [How to manage configurations using Jigit APIs?](https://help.moveworkforward.com/JIGIT/how-to-manage-configurations-using-jigit-apis.md) * [How to use Jigit data in Adaptavist ScriptRunner](https://help.moveworkforward.com/JIGIT/how-to-use-jigit-data-in-adaptavist-scriptrunner.md) * [How to enable debug-level logging for Jigit: Jira GitHub GitLab integration?](https://help.moveworkforward.com/JIGIT/how-to-enable-debug-level-logging-for-jigit-jira-g.md) * [How to configure personal access token to use with the Jigit Development panel](https://help.moveworkforward.com/JIGIT/how-to-configure-personal-access-token-to-use-with.md) * [How to see Gerrit high priority code reviews in the Jigit Development panel](https://help.moveworkforward.com/JIGIT/how-to-see-gerrit-high-priority-code-reviews-in-th.md) * [How to understand the scalability and performance of Jigit?](https://help.moveworkforward.com/JIGIT/how-to-understand-the-scalability-and-performance-.md) * [How to configure webhooks with Jigit](https://help.moveworkforward.com/JIGIT/how-to-configure-webhooks-with-jigit.md) * [How to integrate Jigit with GitHub Dependabot](https://help.moveworkforward.com/JIGIT/how-to-setup-github-dependabot-with-jigit.md) * [How to integrate Jigit with Azure DevOps Security Alerts](https://help.moveworkforward.com/JIGIT/how-to-integrate-jigit-with-azure-devops-security-.md) * [How to run indexation only from a list of nodes in the Data Center cluster](https://help.moveworkforward.com/JIGIT/how-to-run-indexation-only-from-a-list-of-nodes-in.md) * [How to configure default branch name masks in Jira?](https://help.moveworkforward.com/JIGIT/how-to-setup-the-feature-branch-name-mask-in-jira.md) * [How to activate and view Git Activity reports in Jigit](https://help.moveworkforward.com/JIGIT/how-to-activate-and-view-git-activity-reports-in-j.md) * [Statistic collection of Jigit usage](https://help.moveworkforward.com/JIGIT/statistic-collection-of-jigit-usage.md) * [How to define default repositories in Jigit](https://help.moveworkforward.com/JIGIT/how-to-define-default-repositories-in-jigit.md) --- language: "en" --- # How to integrate Jigit with Azure DevOps Security Alerts This guide is about setting up Jigit - GitHub, GitLab, Azure DevOps integration for Jira with Azure DevOps Security Alerts ## Jigit Setup and Azure DevOps Integration Go to your Project settings and then select ![image-20240426-083555.png](https://help.moveworkforward.com/__attachments/a_2c7af8fc6cd7d04db8e1ed1da5c22680cddf4657222f7be25c323d46f533703f/27518aa5-89a5-432c-94c1-69def3ae82e1?cb=dca4f725a23453d0c1426be8845e9878) . From here select the **GitHub security alert configurations** tab and add a new configuration, integrating with GitHub similar to the following. Be sure to link to your specific repository or group: ![image-20240916-164437.png](https://help.moveworkforward.com/__attachments/a_86fbb4ba642b1d216e48374589c2cfd42d5dbc1b4888ebfe96c568f80f82436d/image-20240916-164437.png?cb=023e8448db60b24cf8b0b8bb260a8a90) If everything has been set up correct and successfully integrated with Azure DevOps Security Alerts, then you should see ![image-20240426-084611.png](https://help.moveworkforward.com/__attachments/a_2f092fa12286f3cab34ac6a849d1a483ac25f50ccf86d3afdc3ef3ebfd22b209/48b6afa8-0104-4d76-9f56-41e7eb26334f?cb=77543db26563482189c608a6fb987b25) at the bottom of your Project Sidebar to the left, as shown below. If it's not shown initially, please refresh the page. Clicking this button will take you to the Vulnerabilities screen. ![image-20240426-083733.png](https://help.moveworkforward.com/__attachments/a_3fb360735e6dfa8066c937aada44fe0b440f1b21532d96c9215b6ed220b6d28f/image-20240426-083733.png?cb=f9a878e8bc615eeb4e8bbba7588df1f5) The below is an example of the Vulnerability screen showing a list of vulnerabilities, including their severity, the current status, when they were introduced, relevant identifiers and any linked issues. ![image-20240916-204003.png](https://help.moveworkforward.com/__attachments/a_3d6973e925ea81028bc3e266f96774e41a28c999dcff42dafc879ba723f84d47/image-20240916-204003.png?cb=0b134cf0e68aaaf6f0dc41e65e609d78) From here, you can use the search bar to locate specific vulnerabilities, or limit your selection with a series of filters as shown below. ![image-20240916-210306.png](https://help.moveworkforward.com/__attachments/a_a3af88cbf78c506cde14bbde2fd9afebf23cb7914f380164001d366dd47317f7/image-20240916-210306.png?cb=ffc8fc0f88cdee464147304f8f21cff3) Additionally, by using the three dots Actions menu to the right of each vulnerability as shown below: ![image-20240916-210621.png](https://help.moveworkforward.com/__attachments/a_93bad3778b706a263d528be3bb4eab771eecd3934a6e036a60dbddcc24cf58ff/image-20240916-210621.png?cb=cc33cbd1e4e02d3d7e0d897dcbcc727a) It is possible to create an issue that is linked to the vulnerability ![image-20240916-210800.png](https://help.moveworkforward.com/__attachments/a_35044d98efd5bc7caa98b3e992d729f25b5b04fbd8c9f6985bb6f88fedd3debb/image-20240916-210800.png?cb=184deb008024ec290a50994f947504b0) Alternatively, you can link the vulnerability issues together as shown here: ![image-20240916-211115.png](https://help.moveworkforward.com/__attachments/a_6bf8f00053f3615cbe3b2aaea6c75590916d821e2844e2c653d609d66ad7201a/image-20240916-211115.png?cb=dcb1f70bf5cbdfedc0a878d6c391ef4d) Once issues are linked together, they can be seen to the right of vulnerabilities under the issues column: ![image-20240916-211304.png](https://help.moveworkforward.com/__attachments/a_ebc9d1e290188ca2399b3caa394e5cffa88dc70c3f2c212cbcf537538d48f8fe/image-20240916-211304.png?cb=721c69e6f9f762c4283f8bba22051941) This setup will allow you to quickly and easily review and address vulnerabilities directly from your project in Jira. *Updated* 2024-09-16 --- language: "en" --- # How to link Gerrit changes to Jira issues? Jigit - GitHub, GitLab, Azure DevOps integration for Jira supports integration with **Gerrit Code Review**, allowing you to link Gerrit changes and reviews with your Jira issues. This feature will be available if only it is enabled on the **Global configuration page** by the Jira administrator. To find out, please contact your Jira administrator. ## Associate Gerrit Code Review entities with Jira issues After completing the configuration and establishing a connection between Jira and your Gerrit instance by the**Jira administrator**, you can start linking Gerrit changes with Jira issues: 1. In Gerrit, when creating or updating a code change, include the **Jira issue key** in the commit message or change description. 2. The Gerrit integration plugin will automatically detect the Jira issue key in the commit message or change the description and establish the link between the Gerrit change and the corresponding Jira issue. 3. Details about the Gerrit change will be visible on the **Gerrit tab** and **Gerrit panel**(shown on the right side of the Jira issue view). ![MicrosoftTeams-image (22) upd.png](https://help.moveworkforward.com/__attachments/a_73ee42749d0f5d3fea8ac1f9d01215ad68c4b3d563611b2831885a310f2edf0a/MicrosoftTeams-image%20(22)%20upd.png?cb=a45553141e5cefa5b86536eac4b0a89c) **Jira issue view** ![MicrosoftTeams-image (11)upd.png](https://help.moveworkforward.com/__attachments/a_eb8de91e7d001e1d7e1a76bfc9acfe87a04206063393510e4b0f622e96cf0369/MicrosoftTeams-image%20(11)upd.png?cb=162683361ea576eddd1ef899196df363) *** ** * ** *** [How to set up Gerrit Code Review integration?](https://help.moveworkforward.com/JIGIT/how-to-set-up-gerrit-code-review-integration.md) ## Gerrit display type Since version `7.06.28`, you can select the Gerrit data's List or Table view type. This is done in **Jigit Plugin Config → Global Settings → Gerrit display type**. ![image-20230628-122704.png](https://help.moveworkforward.com/__attachments/a_3a5bf1474ab0a17003c65022bb8c5591cb87f86ad10cfa1ff662b849fa78895b/image-20230628-122704.png?cb=8003ce5552b03296f7cd4d1f9e57eea6) Above the table view, you see the name of the Gerrit configuration. *Updated* : 2023-06-28 --- language: "en" --- # How to link Git entities to Jira issues? Once the repository is configured by the Jira administrator, you need to associate **Git branches, commits,** **pull** and **merge requests** with Jira issues. Jigit uses **Jira issue keys** (for example, **TP-1**) to link Git entities to specific issues: 1. In your Git commit messages**,** the pull and merge request **summary** or**title field** , include the **Jira issue key(s)** that the Git entity relates to. The **branches** to be shown must contain the issue key in the **branch name**. 2. Git entity can contain **more than one** issue key. In this case, it will be displayed on the tab of every mentioned issue. 3. Once the **Git entity** is created and saved, you should be able to see the information related to it on the **Jigit tab**. The issue key should match **exactly**. For instance, the following**Git-commit** messages will be linked to the Jira issue **TP-1**: ![image-20230526-093225.png](https://help.moveworkforward.com/__attachments/a_1a56bf8ca2887749e30391ef5f61b6d5e045527a863248cfdefd7b370344fad3/image-20230526-093225.png?cb=ad82502fcdc296342bcb7d3280d75772) **Jira issue view** ![image-20230526-093812.png](https://help.moveworkforward.com/__attachments/a_4be0644887eb9654ce0336174934c30a8eee9458c8e2c426c4adbb0fb676da7e/image-20230526-093812.png?cb=6ec78146d5e678e6145ba40c89ea986a) ## Smart commits Available since 3.04.01 **Smart commits** are special commit messages that allow you to perform specific actions in Jira through your Git commit messages. Jigit supports smart commits for **transitions**. This feature will be available if only it is enabled in the configuration settings on the **Global configuration page** by the Jira administrator. To find out, please contact your Jira administrator. For example, if you write the commit message in the form **#in-progress** (hash, without spaces and dashes), the issue will be transitioned to the status **In Progress**. The smart commits work similarly to the [Bitbucket Smart Commits](https://confluence.atlassian.com/bitbucketserver/use-smart-commits-802599018.html#UseSmartCommits-transitionWorkflowtransitions). *** ** * ** *** [++How to create a pull or merge in Jira using the Jigit app?++](https://help.moveworkforward.com/JIGIT/how-to-create-a-pull-or-merge-in-jira-using-the-ji.md) [How to create a feature branch in Jira?](https://help.moveworkforward.com/JIGIT/how-to-create-a-feature-branch-in-jira.md) *Updated* : 2023-06-01 --- language: "en" --- # How to link the branch to the Jira issue? The**Link branch** option allows you to link an existing branch from your **Git repository** to the Jira issue. The purpose of the**Link branch**option is to associate an already existing branch in your repository with the specific Jira issue you are working on. This linkage provides visibility and context within Jira, allowing you and your team members to easily access and track the branch associated with the issue. To **сreate or** **link branches** to a Jira issue, and **сreate or link code reviews** using Jigit Development Panelyour **Jira administrator** needs to enable parameter `Display repositories in the development panel` during [Jigit Plugin Configuration](https://help.moveworkforward.com/JIGIT/get-started-guide-for-jira-administrator.md#Jigit-Plugin-Configuration). To enable this, please contact your **Jira administrator**. To link a branch to a Jira issue using the **Jigit Development Panel**, you have follow the steps: 1. Go to the **Jira issue** that corresponds to the branch you want to link. ![image-20240729-175049.png](https://help.moveworkforward.com/__attachments/a_adc95d6cca22a3ed302fe4252ad37a0c03ff62abd2714e79ea49bd8580cf122c/image-20240729-175049.png?cb=46de54e4b2a61f6f73c310ce539d9f4b) 2. On the **Jigit Development Panel** in the Jira issue view, click on the **Link branch** option, which will open a dialogue window. 3. In the dialogue, select the desired branch from your Git repository that you want to link to the Jira issue. ![image-20240729-180041.png](https://help.moveworkforward.com/__attachments/a_67a1de80fd8cc7c9d3ac138658910fbf53f73b1ed3eb4c7c1ed61cbc7b39be69/image-20240729-180041.png?cb=d7b51c260a9a4b9509525d1cf75c8ac9) 4. Confirm or save the selection, and the branch will be linked to the Jira issue. ![image-20240729-180212.png](https://help.moveworkforward.com/__attachments/a_7a0c6cc56a6e1d9e29406ae4cf216b157c8493c6183093c40dbd22863816f423/image-20240729-180212.png?cb=30f0bea842f1e6ab518590d5ee724b1a) *** ** * ** *** [How to link Git entities to Jira issues?](https://help.moveworkforward.com/JIGIT/how-to-link-git-entities-to-jira-issues.md) [++How to create a pull or merge in Jira using the Jigit app?++](https://help.moveworkforward.com/JIGIT/how-to-create-a-pull-or-merge-in-jira-using-the-ji.md) [How to create a feature branch in Jira?](https://help.moveworkforward.com/JIGIT/how-to-create-a-feature-branch-in-jira.md) *Updated* : 2024-07-29 --- language: "en" --- # How to manage configurations using Jigit APIs? Jigit APIs are used to manage configurations for GitLab or GitHub repositories, projects or groups. ## Jigit APIs These APIs are used by the UI, feel free to review the**Network Tab** in your browser to explore more details on how the UI uses them. **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo` **HTTP verb** : `POST` Request headers: * **Content-Type** : `application/x-www-form-urlencoded; charset=UTF-8` Response headers: * **Content-Type** : `text/html;charset=UTF-8` ### Add a configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo/add` Form parameters (encoded):`repo_name=test&url=https%3A%2F%2Fgitlab.com&service_type=GitLab&token=TOKEN&repository_id=GROUP%2FREPO&repo_type=SingleRepository&def_branch=master&branches_strategy=all&request_timeout=10&sleep_timeout=10&sleep_requests=100` | **Parameter name** | **Description** | **Possible value/Default value** | **Requirements** | |--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------| | repo_name | String name that represents a configuration | | Required | | url | GitLab/GitHub url | | Required | | service_type | Predefined value | `GitLab` `GitLab8` `GitHub` | Required | | token | Authentication token | | Required | | repository_id | Repository/group id like "project/repository" | | Required | | repo_type | Predefined value | `SingleRepository` `GroupOfRepositories` | Required | | def_branch | Default branch name to scan | | Required | | branches_strategy | A strategy to scan branches in a repository or a group of repositories | `selected` - scan only selected branch `all` - scan all branches in repository `mask` - scan repositories by pattern defined in "def_branch"(bug/\*) | Default value : `selected` | | request_timeout | Request timeout in seconds | Default: 10 sec | Optional | | sleep_timeout | Timeout in seconds to wait between each batch of requests defined in sleep_requests | Default: 10 sec | Optional | | sleep_requests | Count of requests before waiting "sleep_timeout" seconds. This and previous parameters are used to reduce load on GitLab/GitHub and Jira, especially during initial indexing | Default: 100 | Optional | | include_subgroups | Flag which indicates to include all sub-groups and repositories in a group | Default: "" To enable should be equal to "on" | Optional. It's taken into account only for repo_type=`GroupOfRepositories` | ### Test a configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo/test` Form parameters(encoded):`url=https%3A%2F%2Fgitlab.com&service_type=GitLab&token=TOKEN&change_token=on&repository_id=alex_p1%2Ftest&repo_type=SingleRepository&def_branch=master&include_subgroups=on&branches_strategy=all&request_timeout=10&sleep_timeout=10&sleep_requests=100&repo_name=test` | **Parameter name** | **Description** | **Possible value/Default value** | **Requirements** | |--------------------|----------------------------------------------------------------------------|-----------------------------------------------|----------------------------------------------------------------------------| | repo_name | String name represents configuration | | Required | | url | GitLab/GitHub url | | Required | | service_type | Predefined value | `GitLab` `GitLab8` `GitHub` | Required | | token | Authentication token | | Optional | | repository_id | Repository/group id like "project/repository" | | Required | | repo_type | Predefined value | `SingleRepository` `GroupOfRepositories` | Required | | def_branch | Default branch name to scan | | Required | | request_timeout | Request timeout in seconds | Default: 10 sec | Optional | | include_subgroups | Flag which indicates to include all sub-groups and repositories in a group | Default: "" To enable should be equal to "on" | Optional. It's taken into account only for repo_type=`GroupOfRepositories` | | change_token | Flag which indicates to use provided token instead of existing one | Default: "" To enable should be equal to "on" | Optional | ### Edit configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo/edit` Form parameters(encoded):`url=https%3A%2F%2Fgitlab.com&service_type=GitLab&token=TOKEN&change_token=on&repository_id=&repo_type=SingleRepository&def_branch=master&include_subgroups=on&branches_strategy=mask&request_timeout=10&sleep_timeout=10&sleep_requests=100&repo_name=test` | **Parameter name** | **Description** | **Possible value/Default value** | **Requirements** | |--------------------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------| | repo_name | String name represents configuration | | Required | | url | GitLab/GitHub url | | Required | | service_type | Predefined value | `GitLab` `GitLab8` `GitHub` | Required | | token | Authentication token | | Optional | | repository_id | Repository/group id like "project/repository" | | Required | | def_branch | Default branch name to scan | | Required | | branches_strategy | Predefined value | `selected` - scan only selected branch `all` - scan all branches in repository `mask` - scan repositories by pattern defined in "def_branch"(bug/\*) | Default value : `selected` | | request_timeout | Request timeout in seconds | Default: 10 sec | Optional | | sleep_timeout | Timeout in seconds to wait between each batch of requests defined in sleep_requests | Default: 10 sec | Optional | | sleep_requests | Count of requests before waiting "sleep_timeout" seconds | Default: 100 | Optional | | change_token | Flag which indicates to use provided token instead of existing one | Default: "" To enable should be equal to "on" | Optional | ### Remove configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo/remove` | **Parameter name** | **Description** | **Requirement** | |--------------------|-------------------------------|-----------------| | repo | the name of the configuration | Required | ### Clear data **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo/clear` | **Parameter name** | **Description** | **Requirement** | |--------------------|-------------------------------|-----------------| | repo | the name of the configuration | Required | ### Disable/Enable configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo/activity` | **Parameter name** | **Description** | **Requirement** | |--------------------|-------------------------------|-----------------| | enabled | true or false | Required | | repo | the name of the configuration | Required | ### Add a branch to a configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo/branch/add` | **Parameter name** | **Description** | **Requirement** | |--------------------|-------------------------------|-----------------| | branch | branch name | Required | | repo | the name of the configuration | Required | ### Remove branch from configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/repo/branch/remove` | **Parameter name** | **Description** | **Requirement** | |--------------------|-------------------------------|-----------------| | branch | the branch name | Required | | repo | the name of the configuration | Required | ## Jigit REST APIs There are REST endpoints for reading data Only system administrators can call these endpoints. **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations` **HTTP verb** : `GET` Request headers: * **Content-Type** : `application/json` Response headers: * **Content-Type** : `application/json` ### Get configurations **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations` ![image-20210218-033849.png](https://help.moveworkforward.com/__attachments/a_450bb8feaf4a749733483623697494036f5fa725c0e23afecc064d3857115c19/image-20210218-033849.png?cb=4b119bddede6294627af34e0a5e3b42c) ### Get a configuration **URL** : `{JIRA_BASE_URL}/rest/jigit/1.0/configurations?repoName={repoName}` Where: * repoName is the repoName of the configuration rule (it should be URL encoded). ![image-20210218-033949.png](https://help.moveworkforward.com/__attachments/a_2631e4e32bca89a41533aaba926c178f8d6bb660d4abb20bbcf3f4fcace139ab/image-20210218-033949.png?cb=a6d98dfbfc542471f597de547f2cfecb) ### Get Gerrit changes for an issue URL: `{JIRA_BASE_URL}/rest/jigit/1.0/gerrit/changes/{issueKey}` Where * issueKey is the issue key { "id":"Combiner1~TEST-10_test1~I7759e29c79da78887d931700ee54814f1f28a114", "project":"Combiner1", "branch":"TEST-10_test1", "changeId":"I7759e29c79da78887d931700ee54814f1f28a114", "number":8, "subject":"second review", "owner":{ "id":1000000, "name":"Administrator", "userName":"admin" }, "assignee":{ "id":1000001, "name":"Admin Admin", "userName":"Admin" }, "submitter":{ "id":1000003, "name":"name-submitter", "userName":"username-submitter" }, "created":1643862494000, "updated":1644815007000, "submitted":1644778743000, "reviewers":{ "accounts":[ { "id":1000003, "name":"name-submitter", "userName":"submitter-submitter" } ] }, "status":"MERGED", "messages":[ { "id":"8bda6ec9030bcad40f85d2295a523e885018a5af", "tag":"autogenerated:gerrit:newWipPatchSet", "author":{ "id":1000000, "name":"Administrator", "userName":"admin" }, "realAuthor":{ "id":1000000, "name":"Administrator", "userName":"admin" }, "date":1643862494000, "message":"Uploaded patch set 1.", "revisionNumber":1 }, { "id":"cf7b4d2a1694b12392cd8d9a16baf4246b4f08dd", "author":{ "id":1000003, "name":"name-submitter", "userName":"username" }, "realAuthor":{ "id":1000003, "name":"alex", "userName":"alex" }, "date":1644778679000, "message":"Patch Set 1: Code-Review+2\n\nGood TEST-10", "revisionNumber":1 }, { "id":"e3269cacd262603d727101bfd7fa5705ab2d2d43", "tag":"autogenerated:gerrit:setAssignee", "author":{ "id":1000003, "name":"alex", "userName":"alex" }, "realAuthor":{ "id":1000003, "name":"alex", "userName":"alex" }, "date":1644815007000, "message":"Assignee added: Admin Admin ", "revisionNumber":1 } ], "url":"http://localhost:8080/c/Combiner1/+/8" } *Updated* : 2023-05-30 --- language: "en" --- # How to run indexation only from a list of nodes in the Data Center cluster How to run indexation only from a list of nodes in the Data Center cluster This works only in the multi-node Data Center Jira environment ## Select nodes to run the indexation on Navigate to the global settings of the Jigit app and find there "Worker nodes" setting. Select the name of the worker nodes that will be used to run the commits and pull requests GitHub/GitLab indexation from. ![image-20240219-135650.png](https://help.moveworkforward.com/__attachments/a_89f655188e82c604642138a580aca2d8c8a9e0def9451a0cff77f521e9f8304e/image-20240219-135650.png?cb=add2d843ce65a2b9352ec46dd2c9d714) *Updated* : 2024-02-19 [Next Page](https://help.moveworkforward.com/llms-full.txt/1)