Method commentCreate

src/cml.js:168–331

(opts = {})

  }

  async commentCreate(opts = {}) {
    const {
      commitSha,
      markdownFile,
      pr,
      publish,
      publishUrl,
      report: testReport,
      rmWatermark,
      target: commentTarget = 'auto',
      triggerFile,
      update,
      watch,
      watermarkTitle
    } = opts;

    const drv = this.getDriver();

    if (rmWatermark && update)
      throw new Error('watermarks are mandatory for updatable comments');

    // Create the watermark.
    const watermark = rmWatermark
      ? null
      : new Watermark({
          label: watermarkTitle,
          workflow: drv.workflowId,
          run: drv.runId,
          sha: commitSha || (await this.triggerSha())
        });

    let userReport = testReport;
    try {
      if (!userReport) {
        userReport = await fs.readFile(markdownFile, 'utf-8');
      }
    } catch (err) {
      if (!watch) throw err;
    }

    let report = userReport;
    if (watermark) {
      report = watermark.appendTo(userReport);
    }

    const publishLocalFiles = async (tree) => {
      const nodes = [];

      visit(tree, ['definition', 'image', 'link'], (node) => {
        nodes.push(node);
      });

      const isWatermark = (node) => {
        return node.title && node.title.startsWith('CML watermark');
      };
      const visitor = async (node) => {
        if (node.url && !isWatermark(node)) {
          // Check for embedded images from dvclive