feat(platform): getIssue

[rarkins]

Changes:

Adds optional getIssue() function to platform with useCache exposed. Only needed for platforms which support interactive checkboxes.

Context:

This will be used for upcoming Dashboard race condition fix.

Documentation (please check one with an [x])

• I have updated the documentation, or
• No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

• Code inspection only, or
• Newly added/modified unit tests, or
• No unit tests but ran on a real repository, or
• Both unit tests + ran on a real repository

[viceice]

What about other platforms like gitea ?

[rarkins]

Does gitea have checkbox support now?

[viceice]

Does gitea have checkbox support now?

Yes, will be official supported in v1.15.0, PR merged.

I've a custom javascript to support clickable checkboxes for older versions:

/* eslint-env browser,es2020,greasemonkey */
/* global $,config */
(function () {
  'use strict';
  const prefix = '[VO] ';
  console.log(`${prefix}starting`);
  const cbRe = /^\s*- \[( |x)\] (.+)$/gm;

  try {
    const { owner, repo, type, id } = location.pathname?.match(/(?<owner>[^/]+)\/(?<repo>[^/]+)\/(?<type>pulls|issues)\/(?<id>\d+)/)?.groups ?? {};

    if (!owner) {
      console.log(`${prefix}issue / pr not found`);
      return;
    }

    if ($('#edit-title').length === 0) {
      console.log(`${prefix}no rights`);
      return;
    }

    /**
     *
     * @param {number} idx
     */
    async function process(idx) {
      /**
       * @type {{body:string}}
       */
      let { body } = await fetch(`/api/v1/repos/${owner}/${repo}/issues/${id}`).then((response) => response.json());
      const m = [...body.matchAll(cbRe)];

      if (!m[idx]) {
        console.log(`${prefix}not found: ${idx}`);
        return;
      }
      const line = m[idx];
      console.log(`${prefix}match:`, line[0]);
      body = body.replace(
        line[0],
        line[0].replace(/\[( |x)\]/, (_, val) => (val == ' ' ? '[x]' : '[ ]'))
      );

      body = JSON.stringify({ body });

      const headers = {
        'content-type': 'application/json',
        'X-Csrf-Token': config.csrf,
      };
      const resp = await fetch(`/api/v1/repos/${owner}/${repo}/issues/${id}`, {
        method: 'PATCH',
        headers,
        body,
      });

      if (!resp.ok) {
        return;
      }

      location.reload();
    }

    console.log(`${prefix}${owner}/${repo}/${type}#${id}`);

    $(document).on('click', '.timeline-item.comment.first .render-content .task-list-item > input', (e) => {
      if ($(e.target).closest('a').length > 0) return true;

      // disable checkboxes
      $('.timeline-item.comment.first .render-content .task-list-item > input').prop('disabled', true);

      const idx = $('.timeline-item.comment.first .render-content .task-list-item').index($(e.target).closest('.task-list-item'));
      console.log(`${prefix}click:`, idx);
      process(idx).catch((e) => console.error(`${prefix}unexpected error`, e));
    });

    // enable checkboxes
    $('.timeline-item.comment.first .render-content .task-list-item > input').prop('disabled', false);
  } catch (e) {
    console.error(`${prefix}unexpected error`, e);
  }
})();

😏

[rarkins]

Added gitea but code inspection only. @viceice please double check it

[viceice]

Added same implementation to gitea like github

[renovate-release]

🎉 This PR is included in version 25.43.0 🎉

The release is available on:

• GitHub release
• 25.43.0

Your semantic-release bot 📦🚀