https://github.com/ethomson/issue-dashboard

A customizable dashboard for GitHub issues and pull requests, using GitHub Pages and GitHub Actions
https://github.com/ethomson/issue-dashboard

Last synced: about 1 year ago
JSON representation

A customizable dashboard for GitHub issues and pull requests, using GitHub Pages and GitHub Actions

• Host: GitHub
• URL: https://github.com/ethomson/issue-dashboard
• Owner: ethomson
• License: mit
• Created: 2020-04-28T12:59:17.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2023-10-29T20:25:43.000Z (over 2 years ago)
• Last Synced: 2025-04-04T03:33:44.274Z (about 1 year ago)
• Language: TypeScript
• Homepage: https://ethomson.github.io/issue-dashboard/
• Size: 526 KB
• Stars: 56
• Watchers: 4
• Forks: 20
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

          
# issue-dashboard

[![CI](https://github.com/ethomson/issue-dashboard/workflows/CI/badge.svg)](https://github.com/ethomson/issue-dashboard/actions?query=workflow%3ACI)

**issue-dashboard** is a framework for creating dashboards from user data on GitHub, utilizing [GitHub Actions](https://github.com/features/actions) and [GitHub Pages](https://pages.github.com/).  You can collect data out of GitHub using issue queries or arbitrary JavaScript that you define, and this tool will generate dashboards in HTML or Markdown.

## Overview

A dashboard contains _widgets_ that contain data about your project:

**String widgets** display a string.

![Strings](documentation/example-strings.png)

**Number widgets** display numeric values in a compact form.

![Numbers](documentation/example-numbers.png)

**Graph widgets** display a bar chart.

![Graph](documentation/example-graph.png)

**Table widgets** display multiple rows in tabular form.

![Table](documentation/example-table.png)

For more information about widgets, see the [documentation](documentation#overview).

## Installation

This dashboard tool is an _action_ meant to be used in a [GitHub Actions](https://github.com/features/actions) workflow.  You should provide your input in your workflow, and it will produce HTML or Markdown.  You can then either upload the result to GitHub Pages, or update an issue or file in the repository.

For example, a _step_ in a GitHub Actions workflow to run this action:

```yaml

- name: 'Generate Dashboard'

  uses: ethomson/issue-dashboard@v1

  with:

    config: |

      title: 'Dashboard'

      output:

        format: html

        filename: 'dashboard.html'

      sections:

      - title: 'Pull Requests'

        widgets:

        - type: 'table'

          title: 'New Pull Requests (This Week)'

          issue_query: 'repo:libgit2/libgit2 is:open is:issue created:>{{ date("-7 days") }} sort:created-asc'

    token: ${{ github.token }}

```

For more information about installation, see the [documentation](documentation#installation).

## Example Configuration

* **[Static values](https://github.com/ethomson/issue-dashboard/blob/main/examples/static-values.yml)** ([Rendered output](https://ethomson.github.io/issue-dashboard/examples/static-values.html))

  The simplest way to configure a dashboard is using static values.  This may be useful to provide a rendered dashboard to existing data, which can be exported as YAML or JSON configuration.

* **[GitHub issue and pull request queries](https://github.com/ethomson/issue-dashboard/blob/main/examples/issue-queries.yml)** ([Rendered output](https://ethomson.github.io/issue-dashboard/examples/issue-queries.html))

  Dashboards can query GitHub issue and pull request data easily, by providing the query string.  Either the number of matching results will be displayed (for numeric values) or the actual results of the query will be shown (for tables).  Helpful date and time manipulation functions are included.

* **[JavaScript expressions](https://github.com/ethomson/issue-dashboard/blob/main/examples/javascript-expressions.yml)** ([Rendered output](https://ethomson.github.io/issue-dashboard/examples/javascript-expressions.html))

  Dashboards can execute JavaScript expressions to provide the values for widgets.

For more information about configuration, see the [documentation](documentation#configuration).

## Documentation

Documentation is available at [https://ethomson.github.io/issue-dashboard/documentation/](https://ethomson.github.io/issue-dashboard/documentation/).

## Limitations

Currently, this tool only supports instantaneous data -- for example: how many issues with a certain label are open _right now_, or how many pull requests are currently open that were created within the last week.  It does not support time series, meaning you cannot plot a graph of the number of open issues per day.

## License

Available under the MIT license, see the included [`LICENSE.txt`](LICENSE.txt) file for details.