PR Section Options (pr-section)

JSON Schema

{
  "$id": "https://dlvhdr.github.io/gh-dash/configuration/pr-section/schema.json",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "description": "Defines a section in the dashboard's PRs view.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/pr-section/",
  "properties": {
    "filters": {
      "description": "Defines the GitHub search filters for the PRs in the section's table.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/pr-section/#filters",
      "title": "PR Filters",
      "type": "string"
    },
    "layout": {
      "$ref": "https://dlvhdr.github.io/gh-dash/configuration/layout/pr/schema.json"
    },
    "limit": {
      "minimum": 1,
      "title": "PR Fetch Limit",
      "type": "integer"
    },
    "title": {
      "description": "Defines the section's name as displayed in the tabs for the PRs view.\n\nhttps://dlvhdr.github.io/gh-dash/configuration/pr-section/#title",
      "title": "PR Title",
      "type": "string"
    }
  },
  "required": [
    "title",
    "filters"
  ],
  "title": "PR Section Options",
  "type": "object"
}

Required Properties

• PR Title
• PR Filters

PR Title (title)

This setting defines the section’s name. The dashboard displays this value in the tabs for the PRs view.

PR Filters (filters)

This setting defines the GitHub search filters for the PRs in the section’s table.

Don’t specify is:pr for this setting. The dashboard always adds that filter for PR sections.

You can define any combination of search filters. To make it easier to read and maintain your filters, we recommend using the >- syntax after the filter key and writing one filter per line.

For example:

- title: Involved
  filter: >-
    is:open
    involves:@me
    -author:@me    

For more information about writing filters for searching GitHub, see Understanding the search syntax and Searching issues and pull requests in GitHub’s documentation.

PR Section Layout (layout)

You can define how a PR section displays items in its table by setting options for the available columns. You can define a column’s width, whether it grows to fill available space, and whether the column should be visible at all.

Note that if the length of a column’s text exceeds the defined column width, the view truncates the column’s text to two characters shorter than the column’s width. For example, if the width is 6, gh-dash displays as gh-d.

Column headings have their color defined by the theme.colors.text.primary setting.

For more information, see PR Section Layout

PR Fetch Limit (limit)

This setting defines how many PRs the dashboard should fetch for the section when:

• The dashboard first loads.
• The fetch interval elapses.
• You navigate to the next issue in a table without another fetched issue to display.
• You use the refresh current section or refresh all sections commands.

This setting overrides the defaults.issuesLimit setting.