probot-metadata

Probot: metadata

A Probot extension to store metadata on Issues and Pull Requests.

Usage

import metadata from "probot-metadata";

// where `context` is a Probot `Context`
await metadata(context).set(key, value);

const value = await metadata(context).get(key);

Example

import metadata from "probot-metadata";

export default function (robot) {
  robot.on("issue_comment.created", async (context) => {
    match = context.payload.comment.body.match("/snooze (.*)");
    if (match) {
      metadata(context).set("snooze", match[1]);
    }
  });
}

How it works

This extension is what you might call "a hack". GitHub doesn't have an API for storing metadata on Issues and Pull Requests, but it does have rather large comment fields. GitHub renders the comments as Markdown and will strip any unsupported HTML (including HTML comments like <!-- I can put whatever I want here -->), but still serves up the raw comment body through the API. This extension takes advantage of this "feature" to store JSON values on Issues and Pull Requests as HTML comments.

It will update the body of the original post and append an HTML comment with JSON values for each key. For example:

This is the body of the original post

<!-- probot = {"json": "here"} -->