add filters

content
type
labels

Author: jonabc

README.md

@@ -50,12 +50,24 @@ The `${{ secrets.GITHUB_TOKEN }}` token can be used only when all project column
 2. `repo` to access information in private repositories
 3. `user` to access information in user repositories (if needed)
 
+### Filtering cards mirroring
 
+Cards can be filtered from mirroring by specifying additional inputs on the action workflow.
 
+**type_filter**
 
+Filters mirrored cards only to the specified type.  Must be one of
+- `content` (linked issue or PR)
+- `note`
 
+**label_filter**
 
+Filters mirrored cards based labels that match the input.  Note cards cannot be tagged with labels, and will never be filtered based on this input.
 
+Label filters use exact, case sensitive comparisons to determine whether to mirror a card.  Label filter inputs can contain multiple labels separated by commas (`'first, second'`), and will be mirrored if any labels match (i.e. `OR` logic).
 
+**content_filter**
 
+Filters mirrored cards based on the displayed card content.  Issue/PR titles is evaluated when they are linked as cards, otherwise the card's note text is used.
 
+Content filters use partial, case insensitive comparisons when determining which cards to mirror.  Content filter inputs can contain multiple filters separated by commas (`'first, second'`), and will be mirrored if any content matches are found (i.e. `OR` logic).  Content filters containing commas must be wrapped in quotes (`'first, second, "matching, with a comma"'`)

action.yml

@@ -12,6 +12,15 @@ inputs:
     description: "GitHub token to use for authenticated API calls"
     required: false
     default: ${{ github.token }}
+  type_filter:
+    description: "Filter to a single card type, either 'note' or 'content'"
+    required: false
+  label_filter:
+    description: "Filter to cards containing matching labels"
+    required: false
+  content_filter:
+    description: "Filter to cards with matching note content or issue/PR title"
+    required: false
 runs:
   using: 'node12'
   main: 'dist/index.js'

dist/index.js

@@ -1923,15 +1923,24 @@ module.exports = require("child_process");
 "use strict";
 
 Object.defineProperty(exports, "__esModule", { value: true });
+const projectCardContentFields = `
+id
+title
+labels(first: 20) {
+  nodes {
+    name
+  }
+}
+`.trim();
 const projectCardFields = `
 id
 note
 content {
   ... on Issue {
-    id
+    ${projectCardContentFields}
   }
   ... on PullRequest {
-    id
+    ${projectCardContentFields}
   }
 }
 `.trim();
@@ -2212,7 +2221,6 @@ function ensureCard(card, index, targetColumn) {
         }
         if (!targetCard) {
             // add!
-            core.info(`Creating card in ${targetColumn.name}`);
             const cardData = {};
             if (card.content) {
                 cardData.contentId = card.content.id;
@@ -2228,11 +2236,9 @@ function ensureCard(card, index, targetColumn) {
             targetCard = response['addProjectCard'].cardEdge.node;
             targetColumn.cards.nodes.unshift(targetCard);
             targetCardIndex = 0;
-            core.info(`created card: ${targetCard.id}`);
         }
         if (targetCardIndex !== index) {
             // move!
-            core.info(`moving card: ${targetCard.id}`);
             const moveData = {
                 cardId: targetCard.id,
                 columnId: targetColumn.id,
@@ -2242,11 +2248,61 @@ function ensureCard(card, index, targetColumn) {
             // update the target column card location in the local card array
             targetColumn.cards.nodes.splice(index, 0, targetColumn.cards.nodes.splice(targetCardIndex, 1)[0]);
             targetCardIndex = index;
-            core.info(`moved card: ${targetCard.id} after ${moveData.afterCardId}`);
         }
         return targetCard;
     });
 }
+// content filters are parsed from a string either as wrapped in quotes or comma separated
+const FILTER_LIST_REGEX = /\s*(?:((["'])([^\2]+?)\2)|([^"',]+))\s*/g;
+function getFilterList(input) {
+    if (!input) {
+        return [];
+    }
+    return [...input.matchAll(FILTER_LIST_REGEX)]
+        .map(match => match[3] || match[4])
+        .map(filter => filter.trim())
+        .filter(filter => !!filter);
+}
+function applyFilters(column) {
+    const typeFilter = core.getInput('type_filter', { required: false });
+    if (typeFilter === 'note') {
+        column.cards.nodes = column.cards.nodes.filter(card => !!card.note);
+    }
+    else if (typeFilter === 'content') {
+        column.cards.nodes = column.cards.nodes.filter(card => !!card.content);
+    }
+    else if (typeFilter) {
+        core.warning(`cannot apply unknown type_filter ${typeFilter}`);
+    }
+    const contentFilters = getFilterList(core.getInput('content_filter', { required: false }));
+    if (contentFilters.length > 0) {
+        // match content in case-insensitive manner
+        const contentMatchers = contentFilters.map(filter => new RegExp(filter, 'i'));
+        // filter to cards with displayed text content that matches at least one
+        // of the user-supplied filters
+        column.cards.nodes = column.cards.nodes.filter((card) => {
+            if (card.content) {
+                return contentMatchers.some(filter => filter.test(card.content.title));
+            }
+            else if (card.note) {
+                return contentMatchers.some(filter => filter.test(card.note));
+            }
+            // don't filter cards that cannot be filtered by content
+            return true;
+        });
+    }
+    const labelFilters = getFilterList(core.getInput('label_filter', { required: false }));
+    if (labelFilters.length > 0) {
+        column.cards.nodes = column.cards.nodes.filter((card) => {
+            if (card.content) {
+                // only include cards for issues and PRs that have a matching label
+                return card.content.labels.nodes.some(label => labelFilters.includes(label.name));
+            }
+            // don't filter cards that can't be filtered by labels
+            return true;
+        });
+    }
+}
 function run() {
     return __awaiter(this, void 0, void 0, function* () {
         try {
@@ -2262,6 +2318,9 @@ function run() {
             }
             const sourceColumn = response['sourceColumn'];
             const targetColumn = response['targetColumn'];
+            // apply user supplied filters to cards from the source column and mirror the
+            // target column based on the remaining filters
+            applyFilters(sourceColumn);
             // make sure that a card explaining the automation on the column exists
             // at index 0 in the target column
             const automationNoteCard = {

src/graphql.ts

@@ -1,12 +1,22 @@
+const projectCardContentFields = `
+id
+title
+labels(first: 20) {
+  nodes {
+    name
+  }
+}
+`.trim()
+
 const projectCardFields = `
 id
 note
 content {
   ... on Issue {
-    id
+    ${projectCardContentFields}
   }
   ... on PullRequest {
-    id
+    ${projectCardContentFields}
   }
 }
 `.trim()

src/main.ts

@@ -94,6 +94,70 @@ async function ensureCard(
   return targetCard
 }
 
+// content filters are parsed from a string either as wrapped in quotes or comma separated
+const FILTER_LIST_REGEX = /\s*(?:((["'])([^\2]+?)\2)|([^"',]+))\s*/g
+function getFilterList(input: string): string[] {
+  if (!input) {
+    return []
+  }
+
+  return [...input.matchAll(FILTER_LIST_REGEX)]
+    .map(match => match[3] || match[4])
+    .map(filter => filter.trim())
+    .filter(filter => !!filter)
+}
+
+function applyFilters(column: any): void {
+  const typeFilter = core.getInput('type_filter', {required: false})
+  if (typeFilter === 'note') {
+    column.cards.nodes = column.cards.nodes.filter(card => !!card.note)
+  } else if (typeFilter === 'content') {
+    column.cards.nodes = column.cards.nodes.filter(card => !!card.content)
+  } else if (typeFilter) {
+    core.warning(`cannot apply unknown type_filter ${typeFilter}`)
+  }
+
+  const contentFilters = getFilterList(
+    core.getInput('content_filter', {required: false})
+  )
+  if (contentFilters.length > 0) {
+    // match content in case-insensitive manner
+    const contentMatchers = contentFilters.map(
+      filter => new RegExp(filter, 'i')
+    )
+
+    // filter to cards with displayed text content that matches at least one
+    // of the user-supplied filters
+    column.cards.nodes = column.cards.nodes.filter((card: any): boolean => {
+      if (card.content) {
+        return contentMatchers.some(filter => filter.test(card.content.title))
+      } else if (card.note) {
+        return contentMatchers.some(filter => filter.test(card.note))
+      }
+
+      // don't filter cards that cannot be filtered by content
+      return true
+    })
+  }
+
+  const labelFilters = getFilterList(
+    core.getInput('label_filter', {required: false})
+  )
+  if (labelFilters.length > 0) {
+    column.cards.nodes = column.cards.nodes.filter((card: any): boolean => {
+      if (card.content) {
+        // only include cards for issues and PRs that have a matching label
+        return card.content.labels.nodes.some(label =>
+          labelFilters.includes(label.name)
+        )
+      }
+
+      // don't filter cards that can't be filtered by labels
+      return true
+    })
+  }
+}
+
 async function run(): Promise<void> {
   try {
     const sourceColumnId = core.getInput('source_column_id')
@@ -111,6 +175,10 @@ async function run(): Promise<void> {
     const sourceColumn = response['sourceColumn']
     const targetColumn = response['targetColumn']
 
+    // apply user supplied filters to cards from the source column and mirror the
+    // target column based on the remaining filters
+    applyFilters(sourceColumn)
+
     // make sure that a card explaining the automation on the column exists
     // at index 0 in the target column
     const automationNoteCard: any = {