Function buildMissingIssueHandler

actions/setup/js/missing_issue_helpers.cjs:31–232

* Build a shared handler factory for missing issue handlers. * Encapsulates the common search-or-create issue pipeline, differing only in * template paths, item field names, and item renderers. * * @param {Object} options * @param {string} options.handlerType - Handler type identifier used in l

(options)

 * @returns {HandlerFactoryFunction}
 */
function buildMissingIssueHandler(options) {
  const { handlerType, defaultTitlePrefix, itemsField, templatePath, templateListKey, buildCommentHeader, renderCommentItem, renderIssueItem, defaultLabels = [] } = options;

  return async function main(config = {}) {
    // Extract configuration
    // create_issue: templatable boolean — default true.
    // Accepts: literal boolean (true/false), string 'true'/'false', or a GitHub Actions
    // expression (e.g. '${{ inputs.create-incomplete-issue }}'). Expressions are evaluated
    // by GitHub Actions before this handler runs, so config.create_issue holds the
    // resolved boolean or string value when the handler executes.
    const createIssue = parseBoolTemplatable(config.create_issue, true);
    const titlePrefix = config.title_prefix || defaultTitlePrefix;
    const userLabels = config.labels ? (Array.isArray(config.labels) ? config.labels : config.labels.split(",")).map(label => String(label).trim()).filter(label => label) : [];
    const envLabels = [...new Set([...defaultLabels, ...userLabels])];
    const maxCount = config.max || 1; // Default to 1 to create only one issue per workflow run

    core.info(`Title prefix: ${titlePrefix}`);
    if (envLabels.length > 0) {
      core.info(`Default labels: ${envLabels.join(", ")}`);
    }
    core.info(`Max count: ${maxCount}`);

    // Track how many items we've processed for max limit
    let processedCount = 0;

    // Track created/updated issues
    const processedIssues = [];

    /**
     * Create or update an issue for the missing items
     * @param {string} workflowName - Name of the workflow
     * @param {string} workflowSource - Source path of the workflow
     * @param {string} workflowSourceURL - URL to the workflow source
     * @param {string} runUrl - URL to the workflow run
     * @param {Array<Object>} items - Array of missing item objects
     * @returns {Promise<Object>} Result with success/error status
     */
    async function createOrUpdateIssue(workflowName, workflowSource, workflowSourceURL, runUrl, items) {
      const { owner, repo } = context.repo;

      // Create issue title
      const issueTitle = `${titlePrefix} ${workflowName}`;

      core.info(`Checking for existing issue with title: "${issueTitle}"`);

      // Search for existing open issue with this title
      const searchQuery = `repo:${owner}/${repo} is:issue is:open in:title "${issueTitle}"`;

      try {
        const searchResult = await github.rest.search.issuesAndPullRequests({
          q: searchQuery,
          per_page: 1,
        });

        if (searchResult.data.total_count > 0) {
          // Issue exists, add a comment
          const existingIssue = searchResult.data.items[0];
          core.info(`Found existing issue #${existingIssue.number}: ${existingIssue.html_url}`);