{"id":237967,"date":"2018-09-27T05:54:00","date_gmt":"2018-09-27T09:54:00","guid":{"rendered":"https:\/\/wordpress-756359-3782526.cloudwaysapps.com\/?p=237967"},"modified":"2025-05-30T07:44:18","modified_gmt":"2025-05-30T07:44:18","slug":"2018-09-27-deprecating-github-commit-status-api-for-github-apps-managed-repositories","status":"publish","type":"post","link":"https:\/\/www.travis-ci.com\/blog\/2018-09-27-deprecating-github-commit-status-api-for-github-apps-managed-repositories\/","title":{"rendered":"Deprecating GitHub commit status API updates for GitHub Apps-managed repositories"},"content":{"rendered":"\n

As part of our gradual migration to\u00a0GitHub Apps<\/a>\u00a0for our GitHub integration, we\u2019re formally deprecating\u00a0GitHub Commit Status API<\/a>\u00a0updates for repositories on\u00a0travis-ci.com<\/a>\u00a0managed by GitHub Apps. Instead, these repositories will have status updates reported to the\u00a0GitHub Check Runs API<\/a>.\u00a0We will no longer deliver GitHub Commit Status API updates for repositories managed by GitHub Apps starting\u00a0October 4th, 2018<\/em><\/strong>.<\/p>\n\n\n\n

Your workflow will most likely be impacted only if it relies on either GitHub Protected Branches<\/a> or custom automations dependent on the GitHub Commit Status API<\/a>.<\/p>\n\n\n\n

If your workflow doesn\u2019t fall into either case, the change will have minimal impact – except the deprecated (duplicate) GitHub Status API updates will disappear from your pull requests. If you do use protected branches or the GitHub Commit Status API, we have some recommendations for updating.<\/p>\n\n\n\n

Protected Branches<\/h2>\n\n\n\n

Protected Branches are a feature in GitHub which let you block merging pull requests into specific branches unless status checks have passed.<\/p>\n\n\n\n

If you\u2019re a repository owner, you can update your repositories using protected branches to use status checks per the following:<\/p>\n\n\n\n

    \n
  1. Go to the repository\u2019s Settings<\/code> page, and select Branches<\/code><\/li>\n\n\n\n
  2. In the Branch Protection Settings<\/code> section, click Edit<\/code> for a protected branch<\/li>\n\n\n\n
  3. Scroll down to the second box – Require status checks to pass before merging<\/code>. Select either Travis CI - Pull Request<\/code> or Travis CI - Branch<\/code> or both. (Note: continuous-integration\/travis-ci<\/code> is the Status API event which will be deprecated)<\/li>\n\n\n\n
  4. Save your changes! Rinse and repeat for each protected branch.<\/li>\n<\/ol>\n\n\n\n

    Using the GitHub Commit Status API<\/h2>\n\n\n\n

    Since we will no longer be using the GitHub Commit Status API, automations you\u2019ve built or are using – including third party integrations – that rely on this GitHub endpoint may no longer work properly without the status API updates.<\/p>\n\n\n\n

    If you\u2019re managing your integration with GitHub, we recommend switching to using the GitHub Check Runs API<\/a>. For example, instead of retrieving a Commit Status via a GET<\/code> to \/repos\/:owner\/:repo\/commits\/:ref\/statuses <\/code>, we suggest you use the following endpoint:<\/p>\n\n\n\n

    GET \/repos\/:owner\/:repo\/commits\/:ref\/check-runs<\/code><\/pre>\n\n\n\n
    Read the GitHub Check Runs API docs<\/a> for more information about the payload you can expect.<\/p>\n\n\n\n
    Questions? Feedback?<\/h2>\n\n\n\n
    We hope these recommendations are helpful! If you have a strict requirement on the GitHub Commit Status API that we didn\u2019t cover here, please email support@travis-ci.com<\/a> soon so we can help support through the deprecation process.<\/p>\n\n\n\n
    Of course, if you have any other questions about these changes or there\u2019s anything we can do to help, let us know on the forum, travis-ci.community<\/a> or send us an email as well. Thanks a bunch!<\/p>\n","protected":false},"excerpt":{"rendered":"
    As part of our gradual migration to\u00a0GitHub Apps\u00a0for our GitHub integration, we\u2019re formally deprecating\u00a0GitHub Commit Status API\u00a0updates for repositories on\u00a0travis-ci.com\u00a0managed by GitHub Apps. Instead, these repositories will have status updates reported to the\u00a0GitHub Check Runs API.\u00a0We will no longer deliver GitHub Commit Status API updates for repositories managed by GitHub Apps starting\u00a0October 4th, 2018. Your […]<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_breakdance_hide_in_design_set":false,"_breakdance_tags":"","footnotes":""},"categories":[16],"tags":[15,17,18],"class_list":["post-237967","post","type-post","status-publish","format-standard","hentry","category-news","tag-github","tag-product","tag-support"],"_links":{"self":[{"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/posts\/237967","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/comments?post=237967"}],"version-history":[{"count":1,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/posts\/237967\/revisions"}],"predecessor-version":[{"id":242663,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/posts\/237967\/revisions\/242663"}],"wp:attachment":[{"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/media?parent=237967"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/categories?post=237967"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.travis-ci.com\/wp-json\/wp\/v2\/tags?post=237967"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}