Merge pull request #26 from wpengine/MERL-746-implement-changesets

Implement Changesets

Author: josephfusco

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.changeset/two-chicken-press.md

@@ -0,0 +1,5 @@
+---
+"@wpengine/wp-graphql-content-blocks": patch
+---
+
+test patch

CHANGELOG.md

@@ -1,4 +1,4 @@
-# WPGraphQL Content Blocks
+# WP GraphQL Content Blocks
 
 ## 0.1.0
 

bin/versionPlugin.js

@@ -0,0 +1,170 @@
+#!/usr/bin/env node
+
+/**
+ * Versions a WordPress plugin.
+ *
+ * Ported over from FaustJS
+ */
+import fs from 'fs/promises';
+import path from 'path';
+
+const readFile = (filename) => fs.readFile(filename, { encoding: 'utf8' });
+const writeFile = fs.writeFile;
+
+/**
+ * Runs all WordPress plugin versioning operations for this plugin
+ * including version bumps and readme.txt changelog updates.
+ */
+async function versionPlugin() {
+  const pluginPath = path.join(__dirname, '../');
+  const pluginFile = path.join(pluginPath, 'wp-graphql-content-blocks.php');
+  const readmeTxt = path.join(pluginPath, 'readme.txt');
+  const changelog = path.join(pluginPath, 'CHANGELOG.md');
+
+  const version = await getNewVersion(pluginPath);
+
+  if (version) {
+    bumpPluginHeader(pluginFile, version);
+    await bumpStableTag(readmeTxt, version);
+    generateReadmeChangelog(readmeTxt, changelog);
+  }
+}
+
+/**
+ * Updates the version number found in the header comment of a given
+ * WordPress plugin's main PHP file.
+ *
+ * @param {String} pluginFile Full path to a file containing a WordPress
+ *                            plugin header comment.
+ * @param {String} version    The new version number.
+ */
+async function bumpPluginHeader(pluginFile, version) {
+  return bumpVersion(pluginFile, /^\s*\*\s*Version:\s*([0-9.]+)$/gm, version);
+}
+
+/**
+ * Updates the stable tag found in a given WordPress plugin's readme.txt file.
+ *
+ * @param {String} pluginFile Full path to a file containing a WordPress
+ *                            plugin header comment.
+ * @param {String} version    The new version number.
+ */
+async function bumpStableTag(readmeTxt, version) {
+  return bumpVersion(readmeTxt, /^Stable tag:\s*([0-9.]+)$/gm, version);
+}
+
+/**
+ * Replaces the version number in the first line of a file matching the given
+ * regular expression.
+ *
+ * Note that this function depends on a properly formatted regular expression.
+ * The given regex should meet the following criteria:
+ *
+ *   1. Begins with ^ and ends with $ so that we can match an entire line.
+ *   2. Contains one and only one capturing group that matches only the version
+ *      number portion of the line. For example, in the line " * Version: 1.0.0"
+ *      capturing group 1 of the regex must resolve to "1.0.0".
+ *
+ * @param {String} file    Full path to the file to update.
+ * @param {RegExp} regex   A valid regular expression as noted above.
+ * @param {String} version The new version number.
+ */
+async function bumpVersion(file, regex, version) {
+  try {
+    let data = await readFile(file);
+    const matches = regex.exec(data);
+
+    if (!matches) {
+      throw new Error(`Version string does not exist in ${file}`);
+    }
+
+    // Replace the version number in the captured line.
+    let versionString = matches[0].replace(matches[1], version);
+
+    // Replace the captured line with the new version string.
+    data = data.replace(matches[0], versionString);
+
+    return writeFile(file, data);
+  } catch (e) {
+    console.warn(e);
+  }
+}
+
+/**
+ * Get the current version number from a plugin's package.json file.
+ *
+ * @param {String} pluginPath Full path to the directory containing the plugin's
+ *                            package.json file.
+ * @returns The version number string found in the plugin's package.json.
+ */
+async function getNewVersion(pluginPath) {
+  const packageJsonFile = path.join(pluginPath, 'package.json');
+
+  try {
+    let packageJson = await readFile(packageJsonFile);
+
+    return JSON.parse(packageJson)?.version;
+  } catch (e) {
+    if (e instanceof SyntaxError) {
+      e.message = `${e.message} in ${packageJsonFile}.\n`;
+    }
+
+    console.warn(e);
+  }
+}
+
+/**
+ * Updates the plugin's readme.txt changelog with the latest 3 releases
+ * found in the plugin's CHANGELOG.md file.
+ *
+ * @param {String} readmeTxtFile Full path to the plugin's readme.txt file.
+ * @param {String} changelog     Full path to the plugin's CHANGELOG.md file.
+ */
+async function generateReadmeChangelog(readmeTxtFile, changelog) {
+  let output = "";
+
+  try {
+    let readmeTxt = await readFile(readmeTxtFile);
+    changelog = await readFile(changelog);
+
+    changelog = changelog.replace(
+      '# WP GraphQL Content Blocks',
+      '== Changelog =='
+    );
+
+    // split the contents by new line
+    const changelogLines = changelog.split(/\r?\n/);
+    const processedLines = [];
+    let versionCount = 0;
+
+    // print all lines in current version
+    changelogLines.every((line) => {
+      // Version numbers in CHANGELOG.md are h2
+      if (line.startsWith('## ')) {
+        if (versionCount == 3) {
+          return false;
+        }
+        // Format version number for WordPress
+        line = line.replace('## ', '= ') + ' =';
+        versionCount++;
+      }
+
+      processedLines.push(line);
+
+      return true;
+    });
+
+    changelog = processedLines.join("\n");
+
+    const changelogStart = readmeTxt.indexOf('== Changelog ==');
+
+    output = readmeTxt.substring(0, changelogStart) + changelog;
+    output += "\n[View the full changelog](https://github.com/wpengine/wp-graphql-content-blocks/blob/main/CHANGELOG.md)";
+
+    return writeFile(readmeTxtFile, output);
+  } catch (e) {
+    console.warn(e);
+  }
+}
+
+versionPlugin();