> For the complete documentation index, see [llms.txt](https://developer.harness.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.harness.io/internal-developer-portal/3.0/use-idp/plugins/available-plugins/github-pull-requests.md).

# GitHub Pull Requests

| Plugin details |                                                                |
| -------------- | -------------------------------------------------------------- |
| **Created by** | [Roadie](https://roadie.io)                                    |
| **Category**   | Source Control Management                                      |
| **Source**     | [GitHub](https://github.com/roadieHQ/roadie-backstage-plugins) |
| **Type**       | Open-source plugin                                             |

### Configuration <a href="#configuration" id="configuration"></a>

#### Application configuration YAML <a href="#application-configuration-yaml" id="application-configuration-yaml"></a>

*No action required*

This plugin does not require you to add application configuration.

#### Secrets <a href="#secrets" id="secrets"></a>

This plugin requires the user to log in using the configured GitHub OAuth app. Make sure that you have a GitHub OAuth application created and configured in IDP. For instructions to configure a GitHub OAuth app, go to [OAuth support for plugins](/internal-developer-portal/use-idp/plugins/oauth-support-for-plugins.md).

#### Delegate proxy <a href="#delegate-proxy" id="delegate-proxy"></a>

*No action required*

This plugin does not require a delegate proxy to be set up because GitHub is publicly accessible.

### Layout <a href="#layout" id="layout"></a>

This plugin exports a UI tab that you can use as a new tab for a service or for any other layout page. It also exports a UI card that you can add to the **Overview** section of a catalog layout. Go to **Configure** - **Layout**, select **Service** in the dropdown menu, and then add the following YAML code in a new section:

```yaml
- name: pull-requests
  path: /pull-requests
  title: Pull Requests
  contents:
    - component: EntityGithubPullRequestsContent
```

You can also add a smaller card on the overview page, as follows:

```yaml
- component: EntityGithubPullRequestsOverviewCard
```

### Annotations <a href="#annotations" id="annotations"></a>

If the `catalog-info.yaml` descriptor file for the component is stored in GitHub, the `github.com/project-slug` is automatically added as the `org/repo` where the file is stored. However, you can manually configure or override this setting:

```yaml
metadata:
  annotations:
    github.com/project-slug: org/repo
```

### Support <a href="#support" id="support"></a>

The plugin is owned by [Roadie](https://roadie.io) and managed in the [Roadie plugins repository](https://github.com/roadieHQ/roadie-backstage-plugins) as an open-source project. Create a GitHub issue to report bugs or suggest new features for the plugin.