git-js VS PRIVATE_REPOSITORY

Now we know how to use the API, let's implement it to handle our use cases. To get the git commit date, we're going to use a package called simple-git. We'll add this as a dependency of our Docusaurus project:

I ended up switching to simple-git as nodegit ssh issues had me 2 days behind on trying to get out lesson 8. It provides a very simple interface to effectively accomplish everything I needed. It also allows me to use a personal token to do Git updates to GitHub which I liked a lot better.

simple-git is a JavaScript library which allows you to run git commands from within TypeScript / JavaScript code.

Checkout this repo here

You know, cz-format-extension is very highly expandable. You can use API of Inquirer.js, git-repo-info, and git-js.

In either case of appending a comment to an existing list or committing the first one, the end result of the try catch block will be a new branch checked out with the name of the commentId that was just generated. Be sure to note the difference between checkoutBranch and checkoutLocalBranch in the Simple Git git checkout documentation.

Simple-git is a tool for running git commands in any Node.js application. It gives us access to make all kinds of permutations on top of your commits and branches. With that library, we can easily create a script responsible for releasing our latest changes and running it from the command line.

// comment.ts import { AzureFunction, Context, HttpRequest } from "@azure/functions"; import * as querystring from "querystring"; import util = require("util"); import uuidv4 = require("uuid/v4"); import * as SendGrid from "@sendgrid/mail"; import * as simpleGit from "simple-git/promise"; import { formHelpers } from "../common/formHelpers"; import { Octokit } from "@octokit/rest"; import fs = require("fs"); import rimrafstd = require("rimraf"); import { tmpdir } from "os"; const rimraf = util.promisify(rimrafstd); const mkdir = util.promisify(fs.mkdir); const writeFile = util.promisify(fs.writeFile); const readFile = util.promisify(fs.readFile); SendGrid.setApiKey(process.env["SendGridApiKey"] as string); const httpTrigger: AzureFunction = async function ( context: Context, req: HttpRequest ): Promise { context.log("HTTP trigger function processed a request."); context.res!.headers["Content-Type"] = "application/json"; const body = querystring.parse(req.body); if ( !( body && body.comment && body.postGuid && body.authorEmail && body.authorName ) ) { context.res!.status = 400; context.res!.body = { message: "Comment invalid. Please correct errors and try again.", }; return; } //Initialize Git Repository with Simple Git // generate unique folder name for git repository const tempRepo = uuidv4(); // create empty directory to store comment file await mkdir(`${tmpdir}/${tempRepo}/comments`, { recursive: true, }); // initialize simple-git const git = simpleGit(`${tmpdir}/${tempRepo}`); // initialize git repository in tempRepo await git.init(); // set up git config await Promise.all([ git.addConfig("user.name", "GITHUB_USERNAME"), git.addConfig("user.email", "GITHUB_EMAIL"), ]); // add the private remote await git.addRemote( "private", `https://GITHUB_USERNAME:${process.env["GitHubUserPassword"]}@https://github.com/GITHUB_USERNAME/PRIVATE_REPOSITORY` ); //Checkout git branch with Simple Git // generate unique id for comment const commentId = uuidv4(); // create branch try { // fetch main branch to base of off await git.fetch("private", "main"); // use postID to see if comments already are saved for this post await git.checkout("private/main", ["--", `comments/${body.postId}.json`]); // create new branch named with commentID based off main branch await git.checkoutBranch(`${commentId}`, "private/main"); } catch (error) { // no previous comments are saved for this post await git.checkout("private/main"); await git.checkoutLocalBranch(`${commentId}`); } // Write JSON File with updated Comment data // create comment object to store as JSON in git repository const comment = { id: commentId, timestamp: new Date(new Date().toUTCString()).getTime(), authorEmail: body.authorEmail, authorName: body.authorName, bodyText: body.comment, }; // list of all comments let comments = []; // retrieve existing comments try { comments = JSON.parse( await readFile( `${tmpdir}/${tempRepo}/comments/${body.postId}.json`, "utf8" ) ); } catch (error) { //no previous comments } // add newly submitted comment comments.push(comment); // update or create new comments file with new comment included await writeFile( `${tmpdir}/${tempRepo}/comments/${body.postId}.json`, JSON.stringify(comments, null, 2), "utf8" ); // stage file modifications, commit and push await git.add(`${tmpdir}/${tempRepo}/comments/${body.postId}.json`); await git.commit(`adding comment ${commentId}`); await git.push("private", `${commentId}`); // delete temporary repository await rimraf(`${tmpdir}/${tempRepo}/`); //send notifications and create pull request const userEmail = { to: body.authorEmail, from: "YOUR_NAME@YOUR_WEBSITE", subject: "comment submitted", text: "Your comment will be visible when approved.", }; const adminEmail = { to: "ADMIN_EMAIL", from: "ADMIN_EMAIL", subject: "comment submitted", html: `from: ${body.authorName} email: ${body.authorEmail} comment: ${body.comment}`, }; await Promise.all([ SendGrid.send(userEmail), SendGrid.send(adminEmail), new Octokit({ auth: process.env["GitHubUserPassword"], }).pulls.create({ owner: "GITHUB_USERNAME", repo: "PRIVATE_REPOSITORY", title: `${commentId}`, head: `${commentId}`, base: "main", }), ]); context.res!.status = 200; context.res!.body = { message: "Success!", }; }; export default httpTrigger;