From 4bb79f7cddce6dda30f8011f12190f2af4bc7e6f Mon Sep 17 00:00:00 2001 From: Paul Cowan Date: Thu, 6 Oct 2022 15:20:46 +0100 Subject: [PATCH] update github-issues README Signed-off-by: Paul Cowan --- plugins/github-issues/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/plugins/github-issues/README.md b/plugins/github-issues/README.md index eeb93ab27b..d35f2c5d3f 100644 --- a/plugins/github-issues/README.md +++ b/plugins/github-issues/README.md @@ -61,3 +61,20 @@ However, you can configure the plugin with props: - `itemsPerPage: number = 10` - Issues in the list are paginated, number of issues on a single page is controlled with this prop - `itemsPerRepo: number = 40` - the plugin doesn't download all Issues available on GitHub. By default, it will get at most 40 Issues - this prop controls this behaviour +- `filterBy: object` - the plugin can be configured to filter the query by `assignee`, `createdBy`, `labels`, `states`, `mentioned` or `milestone`. +- `orderBy: object = { field: 'UPDATED_AT', direction: 'DESC' }` - The ordering that the issues are returned can be configured by the `orderBy` field. + +### `filterBy` and `orderBy` example + +```ts + +```