octokit-plugin-unique-issue

> Creates and retrieves unique GitHub issues


Usage

$3

Creates or updates an issue with the provided identifier.

By default, when close_previous is false and a _single_ issue with the provided identifier is found, that issue will be updated, otherwise a new issue is created. An error will be thrown if more than one issue with the provided identifier is found.

When close_previous is true, all existing issues with the provided identifier will be closed before creating a new issue.

createOrUpdateUniqueIssue accepts all supported parameters for creating or updating an issue with the GitHub REST API.

$3

`js
const MyOctokit = Octokit.plugin(uniqueIssue);
const octokit = new MyOctokit({ auth: "secret123" });

const { data, updated } = await octokit.createOrUpdateUniqueIssue({
identifier: "super-unique-identifier",
owner: "tmelliottjr",
repo: "octokit-plugin-unique-issue",
title: "My unique issue",
body: "The body of my unique issue!",
});

const action = updated ? "Updated" : "Created";

console.log(${action} issue: ${data.number});
`

$3

`js
const MyOctokit = Octokit.plugin(uniqueIssue);
const octokit = new MyOctokit({ auth: "secret123" });

const { data, updated, closed_issues } =
await octokit.createOrUpdateUniqueIssue({
identifier: "super-unique-identifier",
owner: "tmelliottjr",
repo: "octokit-plugin-unique-issue",
title: "My unique issue",
body: "The body of my unique issue!",
close_previous: true,
});

console.log(Created issue: ${data.number});

if (closed_issues.length) {
console.log(
Closed issue(s) ${closed_issues.map((issue) => issue.number).join(", ")},
);
}
`

$3

`js
const octokit = new Octokit({ auth: "secret123" });

const { data, updated } = await composeCreateOrUpdateUniqueIssue(octokit, {
identifier: "super-unique-identifier",
owner: "tmelliottjr",
repo: "octokit-plugin-unique-issue",
title: "My unique issue",
body: "The body of my unique issue!",
});
`

Options

How it Works

createOrUpdateUniqueIssue will add an MDAST Comment Marker to an issue's body containing the unique identifier provided.

`html

``

Contributing

See CONTRIBUTING.md

License

MIT