generated from nhcarrigan/template
feat: announce on discourse support forum
✨ This commit was made with love from Hikari~ 🌸
This commit is contained in:
@@ -0,0 +1,54 @@
|
||||
/**
|
||||
* @copyright nhcarrigan
|
||||
* @license Naomi's Public License
|
||||
* @author Naomi Carrigan
|
||||
*/
|
||||
/* eslint-disable @typescript-eslint/naming-convention -- we are making raw API calls. */
|
||||
|
||||
import type { AnnouncementType } from "../interfaces/announcementType.js";
|
||||
|
||||
const announcementCategoryId = 16;
|
||||
|
||||
const tags: Record<AnnouncementType, string> = {
|
||||
community: "Community",
|
||||
company: "Company",
|
||||
products: "Products",
|
||||
};
|
||||
|
||||
/**
|
||||
* Posts an announcement to the NHCarrigan Discourse support forum.
|
||||
* @param title - The title of the announcement.
|
||||
* @param content - The main body of the announcement in markdown.
|
||||
* @param type - Whether the announcement is for a product, community, or company.
|
||||
* @returns A message indicating the success or failure of the operation.
|
||||
*/
|
||||
export const announceOnDiscourse = async(
|
||||
title: string,
|
||||
content: string,
|
||||
type: AnnouncementType,
|
||||
): Promise<string> => {
|
||||
if (process.env.FORUM_API_KEY === undefined) {
|
||||
return "Discourse API key is not set.";
|
||||
}
|
||||
|
||||
const response = await fetch("https://support.nhcarrigan.com/posts.json", {
|
||||
body: JSON.stringify({
|
||||
category: announcementCategoryId,
|
||||
raw: content,
|
||||
tags: [ tags[type] ],
|
||||
title: title,
|
||||
}),
|
||||
headers: {
|
||||
"Api-Key": process.env.FORUM_API_KEY,
|
||||
"Api-Username": "hikari",
|
||||
"Content-Type": "application/json",
|
||||
},
|
||||
method: "POST",
|
||||
});
|
||||
|
||||
if (!response.ok) {
|
||||
return `Failed to post to Discourse. Status: ${response.status.toString()} ${response.statusText}`;
|
||||
}
|
||||
|
||||
return "Successfully posted announcement to Discourse~! ✨";
|
||||
};
|
||||
Reference in New Issue
Block a user