docs/v0.15/Plugins/github/index.html - incubator-devlake-website - Git at Google

 <!doctype html>
 <html lang="en-GB" dir="ltr" class="docs-wrapper docs-doc-page docs-version-v0.15 plugin-docs plugin-id-default docs-doc-id-Plugins/github">
 <head>
 <meta charset="UTF-8">
 <meta name="viewport" content="width=device-width,initial-scale=1">
 <meta name="generator" content="Docusaurus v2.0.0-rc.1">
 <link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache DevLake - Open-Source Dev Data Platform for Productivity RSS Feed">
 <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache DevLake - Open-Source Dev Data Platform for Productivity Atom Feed"><title data-rh="true">GitHub | Apache DevLake - Open-Source Dev Data Platform for Productivity</title><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://devlake.apache.org/docs/v0.15/Plugins/github"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="keywords" content="Engineering Productivity, Open-Source Engineering, Open-Source Integration Tools, Data Integrates Platform, Open-Source Dev Platform, Open-Source Data Integrates, DevOps Tools Integrates, Open-Source DevOps Tools"><meta data-rh="true" name="docusaurus_version" content="v0.15"><meta data-rh="true" name="docusaurus_tag" content="docs-default-v0.15"><meta data-rh="true" name="docsearch:version" content="v0.15"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-v0.15"><meta data-rh="true" property="og:title" content="GitHub | Apache DevLake - Open-Source Dev Data Platform for Productivity"><meta data-rh="true" name="description" content="GitHub Plugin
 "><meta data-rh="true" property="og:description" content="GitHub Plugin
 "><link data-rh="true" rel="icon" href="/img/logo.svg"><link data-rh="true" rel="canonical" href="https://devlake.apache.org/docs/v0.15/Plugins/github"><link data-rh="true" rel="alternate" href="https://devlake.apache.org/docs/v0.15/Plugins/github" hreflang="en-GB"><link data-rh="true" rel="alternate" href="https://devlake.apache.org/zh/docs/v0.15/Plugins/github" hreflang="zh"><link data-rh="true" rel="alternate" href="https://devlake.apache.org/docs/v0.15/Plugins/github" hreflang="x-default"><link rel="stylesheet" href="/assets/css/styles.ddc6bf33.css">
 <link rel="preload" href="/assets/js/runtime~main.da0d55e0.js" as="script">
 <link rel="preload" href="/assets/js/main.a12a6bb4.js" as="script">
 </head>
 <body class="navigation-with-keyboard">
 <script>!function(){function t(t){document.documentElement.setAttribute("data-theme",t)}var e=function(){var t=null;try{t=localStorage.getItem("theme")}catch(t){}return t}();t(null!==e?e:"light")}()</script><div id="__docusaurus">
 <div role="region"><a href="#" class="skipToContent_fXgn">Skip to main content</a></div><nav class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Navigation bar toggle" class="navbar__toggle clean-btn" type="button" tabindex="0"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="apache devlake" class="themedImage_ToTc themedImage--light_HNdA"><img src="/img/logo.svg" alt="apache devlake" class="themedImage_ToTc themedImage--dark_i4oU"></div><b class="navbar__title text--truncate">Apache DevLake</b></a></div><div class="navbar__items navbar__items--right"><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Docs</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/Overview/Introduction">Next</a></li><li><a class="dropdown__link" href="/docs/v1.0/Overview/Introduction">v1.0 (Stable)</a></li><li><a class="dropdown__link" href="/docs/v0.21/Overview/Introduction">v0.21</a></li><li><a class="dropdown__link" href="/docs/v0.20/Overview/Introduction">v0.20</a></li><li><a class="dropdown__link" href="/docs/v0.19/Overview/Introduction">v0.19</a></li><li><a class="dropdown__link" href="/docs/v0.18/Overview/Introduction">v0.18</a></li><li><a class="dropdown__link" href="/docs/v0.17/Overview/Introduction">v0.17</a></li><li><a class="dropdown__link" href="/docs/v0.16/Overview/Introduction">v0.16</a></li><li><a class="dropdown__link" href="/docs/v0.15/Overview/Introduction">v0.15</a></li></ul></div><a class="navbar__item navbar__link" href="/livedemo/EngineeringLeads/DORA">Use Cases</a><a class="navbar__item navbar__link" href="/community/">Community</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/blogOverview">Blog</a><a href="https://github.com/apache/incubator-devlake" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub</a><a class="navbar__item navbar__link" href="/download">Download</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://privacy.apache.org/policies/privacy-policy-public.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="Switch between dark and light mode (currently light mode)" aria-label="Switch between dark and light mode (currently light mode)"><svg viewBox="0 0 24 24" width="24" height="24" class="lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" class="darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg></button></div><div class="searchBox_ZlJk"><div class="navbar__search searchBarContainer_NW3z"><input placeholder="Search" aria-label="Search" class="navbar__search-input"><div class="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><aside class="theme-doc-sidebar-container docSidebarContainer_b6E3"><div class="sidebar_njMd"><nav class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/v0.15/Overview">Overview</a><button aria-label="Toggle the collapsible sidebar category &#x27;Overview&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/v0.15/GettingStarted">Getting Started</a><button aria-label="Toggle the collapsible sidebar category &#x27;Getting Started&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/v0.15/UserManuals">User Manuals</a><button aria-label="Toggle the collapsible sidebar category &#x27;User Manuals&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/v0.15/Metrics">Metrics</a><button aria-label="Toggle the collapsible sidebar category &#x27;Metrics&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/v0.15/DataModels">Data Models</a><button aria-label="Toggle the collapsible sidebar category &#x27;Data Models&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/v0.15/DeveloperManuals">Developer Manuals</a><button aria-label="Toggle the collapsible sidebar category &#x27;Developer Manuals&#x27;" type="button" class="clean-btn menu__caret"></button></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist menu__link--active" aria-expanded="true" href="/docs/v0.15/Plugins">Plugins</a><button aria-label="Toggle the collapsible sidebar category &#x27;Plugins&#x27;" type="button" class="clean-btn menu__caret"></button></div><ul style="display:block;overflow:visible;height:auto" class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/bitbucket">BitBucket(Beta)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/customize">Customize</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/dbt">DBT</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/feishu">Feishu</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/gitee">Gitee(WIP)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/gitextractor">GitExtractor</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/v0.15/Plugins/github">GitHub</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/gitlab">GitLab</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/jenkins">Jenkins</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/jira">Jira</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/pagerduty">PagerDuty(WIP)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/refdiff">RefDiff</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/tapd">Tapd(Beta)</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/webhook">Webhook</a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-2 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/v0.15/Plugins/zentao">Zentao(Beta)</a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="menu__link menu__link--sublist" aria-expanded="false" href="/docs/v0.15/Troubleshooting">Troubleshooting</a><button aria-label="Toggle the collapsible sidebar category &#x27;Troubleshooting&#x27;" type="button" class="clean-btn menu__caret"></button></div></li></ul></nav></div></aside><main class="docMainContainer_gTbr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs" itemscope="" itemtype="https://schema.org/BreadcrumbList"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_OVgt"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item"><a class="breadcrumbs__link" itemprop="item" href="/docs/v0.15/Plugins"><span itemprop="name">Plugins</span></a><meta itemprop="position" content="1"></li><li itemscope="" itemprop="itemListElement" itemtype="https://schema.org/ListItem" class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link" itemprop="name">GitHub</span><meta itemprop="position" content="2"></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: v0.15</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>GitHub</h1></header><h2 class="anchor anchorWithStickyNavbar_LWe7" id="summary">Summary<a class="hash-link" href="#summary" title="Direct link to heading"></a></h2><p>This plugin collects GitHub data through <a href="https://docs.github.com/en/rest/" target="_blank" rel="noopener noreferrer">REST API</a> and <a href="https://docs.github.com/en/graphql" target="_blank" rel="noopener noreferrer">GraphQL API</a>. It then computes and visualizes various DevOps metrics from the GitHub data, which helps tech leads, QA and DevOps engineers, and project managers to answer questions such as:</p><ul><li>Is this month more productive than last?</li><li>How fast do we respond to customer requirements?</li><li>Was our quality improved or not?</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="entities">Entities<a class="hash-link" href="#entities" title="Direct link to heading"></a></h2><p>Check out the <a href="/docs/v0.15/Overview/SupportedDataSources#data-collection-scope-by-each-plugin">GitHub entities</a> collected by this plugin.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="data-refresh-policy">Data Refresh Policy<a class="hash-link" href="#data-refresh-policy" title="Direct link to heading"></a></h2><p>Check out the <a href="/docs/v0.15/Overview/SupportedDataSources#github">data refresh policy</a> of this plugin.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="metrics">Metrics<a class="hash-link" href="#metrics" title="Direct link to heading"></a></h2><p>Metrics that can be calculated based on the data collected from GitHub:</p><ul><li><a href="/docs/v0.15/Metrics/RequirementCount">Requirement Count</a></li><li><a href="/docs/v0.15/Metrics/RequirementLeadTime">Requirement Lead Time</a></li><li><a href="/docs/v0.15/Metrics/RequirementDeliveryRate">Requirement Delivery Rate</a></li><li><a href="/docs/v0.15/Metrics/RequirementGranularity">Requirement Granularity</a></li><li><a href="/docs/v0.15/Metrics/BugAge">Bug Age</a></li><li><a href="/docs/v0.15/Metrics/BugCountPer1kLinesOfCode">Bug Count per 1k Lines of Code</a></li><li><a href="/docs/v0.15/Metrics/IncidentAge">Incident Age</a></li><li><a href="/docs/v0.15/Metrics/IncidentCountPer1kLinesOfCode">Incident Count per 1k Lines of Code</a></li><li><a href="/docs/v0.15/Metrics/CommitCount">Commit Count</a></li><li><a href="/docs/v0.15/Metrics/CommitAuthorCount">Commit Author Count</a></li><li><a href="/docs/v0.15/Metrics/AddedLinesOfCode">Added Lines of Code</a></li><li><a href="/docs/v0.15/Metrics/DeletedLinesOfCode">Deleted Lines of Code</a></li><li><a href="/docs/v0.15/Metrics/PRCount">PR Count</a></li><li><a href="/docs/v0.15/Metrics/PRCycleTime">PR Cycle Time</a></li><li><a href="/docs/v0.15/Metrics/PRCodingTime">PR Coding Time</a></li><li><a href="/docs/v0.15/Metrics/PRPickupTime">PR Pickup Time</a></li><li><a href="/docs/v0.15/Metrics/PRReviewTime">PR Review Time</a></li><li><a href="/docs/v0.15/Metrics/PRDeployTime">PR Deploy Time</a></li><li><a href="/docs/v0.15/Metrics/PRTimeToMerge">PR Time To Merge</a></li><li><a href="/docs/v0.15/Metrics/PRMergeRate">PR Merge Rate</a></li><li><a href="/docs/v0.15/Metrics/PRReviewDepth">PR Review Depth</a></li><li><a href="/docs/v0.15/Metrics/PRSize">PR Size</a></li><li><a href="/docs/v0.15/Metrics/BuildCount">Build Count</a></li><li><a href="/docs/v0.15/Metrics/BuildDuration">Build Duration</a></li><li><a href="/docs/v0.15/Metrics/BuildSuccessRate">Build Success Rate</a></li><li><a href="/docs/v0.15/Metrics/DeploymentFrequency">DORA - Deployment Frequency</a></li><li><a href="/docs/v0.15/Metrics/LeadTimeForChanges">DORA - Lead Time for Changes</a></li><li><a href="/docs/v0.15/Metrics/MTTR">DORA - Median Time to Restore Service</a></li><li><a href="/docs/v0.15/Metrics/CFR">DORA - Change Failure Rate</a></li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="configuration">Configuration<a class="hash-link" href="#configuration" title="Direct link to heading"></a></h2><ul><li>Configuring GitHub via <a href="/docs/v0.15/UserManuals/ConfigUI/GitHub">Config UI</a></li><li>Configuring GitHub via Config UI&#x27;s <a href="/docs/v0.15/UserManuals/ConfigUI/AdvancedMode#1-github">advanced mode</a>.</li></ul><h2 class="anchor anchorWithStickyNavbar_LWe7" id="api-sample-request">API Sample Request<a class="hash-link" href="#api-sample-request" title="Direct link to heading"></a></h2><p>You can trigger data collection by making a POST request to <code>/pipelines</code>.</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">curl &#x27;http://localhost:8080/pipelines&#x27; \</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">--header &#x27;Content-Type: application/json&#x27; \</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">--data-raw &#x27;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  &quot;name&quot;: &quot;project1-BLUEPRINT&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  &quot;blueprintId&quot;: 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  &quot;plan&quot;: [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        &quot;plugin&quot;: &quot;github&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        &quot;options&quot;: {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          &quot;connectionId&quot;: 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          &quot;scopeId&quot;: &quot;384111310&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          &quot;transformationRules&quot;:{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;deploymentPattern&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;productionPattern&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueComponent&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issuePriority&quot;:&quot;(high|medium|low)$&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueSeverity&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueTypeBug&quot;:&quot;(bug)$&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueTypeIncident&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueTypeRequirement&quot;:&quot;(feature|feature-request)$&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;prBodyClosePattern&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;prComponent&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;prType&quot;:&quot;&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    ]</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  ]</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">&#x27;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>or</p><div class="codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-text codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain">curl &#x27;http://localhost:8080/pipelines&#x27; \</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">--header &#x27;Content-Type: application/json&#x27; \</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">--data-raw &#x27;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  &quot;name&quot;: &quot;project1-BLUEPRINT&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  &quot;blueprintId&quot;: 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  &quot;plan&quot;: [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    [</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        &quot;plugin&quot;: &quot;github&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        &quot;options&quot;: {</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          &quot;connectionId&quot;: 1,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          &quot;owner&quot;: &quot;apache&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          &quot;repo&quot;: &quot;incubator-devlake&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          &quot;transformationRules&quot;:{</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;deploymentPattern&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;productionPattern&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueComponent&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issuePriority&quot;:&quot;(high|medium|low)$&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueSeverity&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueTypeBug&quot;:&quot;(bug)$&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueTypeIncident&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;issueTypeRequirement&quot;:&quot;(feature|feature-request)$&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;prBodyClosePattern&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;prComponent&quot;:&quot;&quot;,</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">            &quot;prType&quot;:&quot;&quot;</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">          }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">        }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">      }</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">    ]</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">  ]</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">}</span><br></span><span class="token-line" style="color:#393A34"><span class="token plain">&#x27;</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="references">References<a class="hash-link" href="#references" title="Direct link to heading"></a></h2><ul><li><a href="/docs/v0.15/DeveloperManuals/DeveloperSetup#references">references</a></li></ul></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/incubator-devlake-website/edit/main/versioned_docs/version-v0.15/Plugins/github.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/v0.15/Plugins/gitextractor"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">GitExtractor</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/v0.15/Plugins/gitlab"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">GitLab</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#summary" class="table-of-contents__link toc-highlight">Summary</a></li><li><a href="#entities" class="table-of-contents__link toc-highlight">Entities</a></li><li><a href="#data-refresh-policy" class="table-of-contents__link toc-highlight">Data Refresh Policy</a></li><li><a href="#metrics" class="table-of-contents__link toc-highlight">Metrics</a></li><li><a href="#configuration" class="table-of-contents__link toc-highlight">Configuration</a></li><li><a href="#api-sample-request" class="table-of-contents__link toc-highlight">API Sample Request</a></li><li><a href="#references" class="table-of-contents__link toc-highlight">References</a></li></ul></div></div></div></div></main></div></div><footer class="footer footer--dark"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title">Docs</div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/docs/GettingStarted">Getting Started</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/DataModels/DevLakeDomainLayerSchema">Data Models</a></li><li class="footer__item"><a class="footer__link-item" href="/docs/Metrics">Engineering Metrics</a></li></ul></div><div class="col footer__col"><div class="footer__title">Community</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://join.slack.com/t/devlake-io/shared_invite/zt-2ox842kuu-_6x3Lwdj88YpzKhMRpgnMg" target="_blank" rel="noopener noreferrer" class="footer__link-item">Slack</a></li><li class="footer__item"><a href="https://github.com/apache/incubator-devlake/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub Issue Tracker</a></li><li class="footer__item"><a href="https://github.com/apache/incubator-devlake-website/issues" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub Issue Tracker For Docs</a></li></ul></div><div class="col footer__col"><div class="footer__title">More</div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://github.com/apache/incubator-devlake" target="_blank" rel="noopener noreferrer" class="footer__link-item">GitHub</a></li><li class="footer__item"><a href="https://twitter.com/ApacheDevLake" target="_blank" rel="noopener noreferrer" class="footer__link-item">Twitter</a></li><li class="footer__item"><a class="footer__link-item" href="/community/trademark">Trademark Guidelines</a></li></ul></div></div><div class="footer__bottom text--center"><div class="footer__copyright">
         <div style="margin-top: 20px">
           <a href="https://incubator.apache.org/" target="_blank"><img style="height:40px; margin-bottom: 10px; margin-top: 10px" alt="Apache Software Foundation" src="/img/apache-incubator.svg"></a>
           <p style="text-align:left; font-weight: 300; font-size: 0.8em;">Apache DevLake is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.</p>
           <p style="text-align:left; font-weight: 300; font-size: 0.8em;">Copyright ©2025 Apache DevLake, DevLake, Apache, the Apache feather logo and the Apache DevLake project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries.</p>
         </div>
         </div></div></div></footer></div>
 <script src="/assets/js/runtime~main.da0d55e0.js"></script>
 <script src="/assets/js/main.a12a6bb4.js"></script>
 </body>
 </html>