{"id":2338,"date":"2020-07-30T05:37:36","date_gmt":"2020-07-30T05:37:36","guid":{"rendered":"https:\/\/www.vuepilot.com\/support\/?post_type=article&p=2338"},"modified":"2023-10-17T07:09:21","modified_gmt":"2023-10-17T07:09:21","slug":"github-pull-request-dashboard-setup","status":"publish","type":"article","link":"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/","title":{"rendered":"GitHub Pull Request Dashboard Setup"},"content":{"rendered":"

Using the VuePilot GitHub app requires you to generate an access token that we then use to call the GitHub app on your behalf and retrieve repository information to generate the dashboard.<\/p>\n

GitHub allows you to create a “Fine Grain<\/strong>” personal access token of which we can permit only the required READ access to COMMITS<\/strong> and PULL REQUESTS\u00a0<\/strong>and nothing else creating a secure access token.<\/p>\n

Essentially we will generate an access token for your account that will only be used for VuePilot and only has the required permissions to display the pull request dashboards.<\/p>\n

Here’s how to get up and running<\/p>\n

Step 1: Enable Fine Grain Access Token To Your Organization<\/h2>\n

By default you cannot access your organizations commits or pull request via token. We can enable this for administrators only.\u00a0 You can also restrict which repositories have access and approve or deny specific requests.<\/p>\n

Follow the instructions here: https:\/\/docs.github.com\/en\/organizations\/managing-programmatic-access-to-your-organization\/setting-a-personal-access-token-policy-for-your-organization<\/a><\/p>\n

Step 2: Create The Fine Grain Personal Access Token<\/h2>\n

Follow the steps outlined to create your fine grain personal access token here (Not classic token):\u00a0 https:\/\/docs.github.com\/en\/authentication\/keeping-your-account-and-data-secure\/managing-your-personal-access-tokens<\/a><\/p>\n

When creating your token, under “Repository Permissions<\/strong>” find the rows for Commits<\/strong> and Pull Requests<\/strong>.
\nSelect “Access: Read-only”<\/strong> on both.\u00a0 Leave everything else as “No Access<\/strong>”<\/p>\n

Be sure to copy the token shown at the end of the process. You will not see it again.<\/p>\n

\"\" \"\"<\/p>\n

 <\/p>\n

Step 4: Create The GitHub Pull Request Dashboard App<\/h2>\n

Now we’re ready to create the app, simply visit the VuePilot Apps section on the dashboard and create a new GitHub app.<\/p>\n

Enter in your user access token that we generated above<\/p>\n

Once you save the app, the access token will not be visible on this form again. You can still update the token at any time by entering a new one and clicking save.<\/p><\/blockquote>\n

Then enter your organisation name (owner name) and the repo name.<\/p>\n

For example, the the URL to your repo is: https:\/\/github.com\/microsoft\/TypeScript<\/em><\/strong>\u00a0 then the owner name is “microsoft<\/strong>” and the repo name is “TypeScript<\/strong>“.<\/p>\n

Click save and you’re done. You can now preview the dashboard and assign to your screens<\/p>\n

\"GitHub<\/p>\n","protected":false},"excerpt":{"rendered":"

Using the VuePilot GitHub app requires you to generate an access token that we then use to call the GitHub app on your behalf and retrieve repository information to generate the dashboard. GitHub allows you to create a “Fine Grain” personal access token of which we can permit only the required READ access to COMMITS […]<\/p>\n","protected":false},"author":1,"featured_media":2342,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","format":"standard","article-category":[62,46],"article-tag":[63],"class_list":["post-2338","article","type-article","status-publish","format-standard","has-post-thumbnail","hentry","article-category-dashboards","article-category-digital-signage","article-tag-github"],"yoast_head":"\nGitHub Pull Request Dashboard Setup – VuePilot<\/title>\n<meta name=\"description\" content=\"Create GitHub pull request dashboards using VuePilot that shows status and state of open pull requests. Setup a READ ONLY user account for use with the app\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"GitHub Pull Request Dashboard Setup – VuePilot\" \/>\n<meta property=\"og:description\" content=\"Create GitHub pull request dashboards using VuePilot that shows status and state of open pull requests. Setup a READ ONLY user account for use with the app\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/\" \/>\n<meta property=\"og:site_name\" content=\"VuePilot\" \/>\n<meta property=\"article:publisher\" content=\"https:\/\/www.facebook.com\/vuepilot\" \/>\n<meta property=\"article:modified_time\" content=\"2023-10-17T07:09:21+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.vuepilot.com\/wp-content\/uploads\/2020\/07\/Screen-Shot-2020-07-30-at-11.26.00-am.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1200\" \/>\n\t<meta property=\"og:image:height\" content=\"611\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:site\" content=\"@vuepilot\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/\",\"url\":\"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/\",\"name\":\"GitHub Pull Request Dashboard Setup – VuePilot\",\"isPartOf\":{\"@id\":\"https:\/\/www.vuepilot.com\/support\/#website\"},\"datePublished\":\"2020-07-30T05:37:36+00:00\",\"dateModified\":\"2023-10-17T07:09:21+00:00\",\"description\":\"Create GitHub pull request dashboards using VuePilot that shows status and state of open pull requests. Setup a READ ONLY user account for use with the app\",\"breadcrumb\":{\"@id\":\"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.vuepilot.com\/support\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"GitHub Pull Request Dashboard Setup\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.vuepilot.com\/support\/#website\",\"url\":\"https:\/\/www.vuepilot.com\/support\/\",\"name\":\"VuePilot\",\"description\":\"Digital signage help and assistance\",\"publisher\":{\"@id\":\"https:\/\/www.vuepilot.com\/support\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.vuepilot.com\/support\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.vuepilot.com\/support\/#organization\",\"name\":\"VuePilot\",\"url\":\"https:\/\/www.vuepilot.com\/support\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.vuepilot.com\/support\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.vuepilot.com\/wp-content\/uploads\/2020\/06\/vuepilot-social-banner.jpg\",\"contentUrl\":\"https:\/\/www.vuepilot.com\/wp-content\/uploads\/2020\/06\/vuepilot-social-banner.jpg\",\"width\":1200,\"height\":630,\"caption\":\"VuePilot\"},\"image\":{\"@id\":\"https:\/\/www.vuepilot.com\/support\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/www.facebook.com\/vuepilot\",\"https:\/\/twitter.com\/vuepilot\"]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"GitHub Pull Request Dashboard Setup – VuePilot","description":"Create GitHub pull request dashboards using VuePilot that shows status and state of open pull requests. Setup a READ ONLY user account for use with the app","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/","og_locale":"en_US","og_type":"article","og_title":"GitHub Pull Request Dashboard Setup – VuePilot","og_description":"Create GitHub pull request dashboards using VuePilot that shows status and state of open pull requests. Setup a READ ONLY user account for use with the app","og_url":"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/","og_site_name":"VuePilot","article_publisher":"https:\/\/www.facebook.com\/vuepilot","article_modified_time":"2023-10-17T07:09:21+00:00","og_image":[{"width":1200,"height":611,"url":"https:\/\/www.vuepilot.com\/wp-content\/uploads\/2020\/07\/Screen-Shot-2020-07-30-at-11.26.00-am.jpg","type":"image\/jpeg"}],"twitter_card":"summary_large_image","twitter_site":"@vuepilot","twitter_misc":{"Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/","url":"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/","name":"GitHub Pull Request Dashboard Setup – VuePilot","isPartOf":{"@id":"https:\/\/www.vuepilot.com\/support\/#website"},"datePublished":"2020-07-30T05:37:36+00:00","dateModified":"2023-10-17T07:09:21+00:00","description":"Create GitHub pull request dashboards using VuePilot that shows status and state of open pull requests. Setup a READ ONLY user account for use with the app","breadcrumb":{"@id":"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/www.vuepilot.com\/support\/article\/github-pull-request-dashboard-setup\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.vuepilot.com\/support\/"},{"@type":"ListItem","position":2,"name":"GitHub Pull Request Dashboard Setup"}]},{"@type":"WebSite","@id":"https:\/\/www.vuepilot.com\/support\/#website","url":"https:\/\/www.vuepilot.com\/support\/","name":"VuePilot","description":"Digital signage help and assistance","publisher":{"@id":"https:\/\/www.vuepilot.com\/support\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.vuepilot.com\/support\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.vuepilot.com\/support\/#organization","name":"VuePilot","url":"https:\/\/www.vuepilot.com\/support\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.vuepilot.com\/support\/#\/schema\/logo\/image\/","url":"https:\/\/www.vuepilot.com\/wp-content\/uploads\/2020\/06\/vuepilot-social-banner.jpg","contentUrl":"https:\/\/www.vuepilot.com\/wp-content\/uploads\/2020\/06\/vuepilot-social-banner.jpg","width":1200,"height":630,"caption":"VuePilot"},"image":{"@id":"https:\/\/www.vuepilot.com\/support\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/www.facebook.com\/vuepilot","https:\/\/twitter.com\/vuepilot"]}]}},"_links":{"self":[{"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/article\/2338","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/article"}],"about":[{"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/types\/article"}],"author":[{"embeddable":true,"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/comments?post=2338"}],"version-history":[{"count":12,"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/article\/2338\/revisions"}],"predecessor-version":[{"id":2805,"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/article\/2338\/revisions\/2805"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/media\/2342"}],"wp:attachment":[{"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/media?parent=2338"}],"wp:term":[{"taxonomy":"article-category","embeddable":true,"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/article-category?post=2338"},{"taxonomy":"article-tag","embeddable":true,"href":"https:\/\/www.vuepilot.com\/support\/wp-json\/wp\/v2\/article-tag?post=2338"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}