feat: add template_url and get rid of base file

Author: anonrig

README.md

@@ -25,7 +25,7 @@ jobs:
       - name: Start Patch
         uses: pkgjs/[email protected]
         with:
-          base_file_path: './base.md'
+          base_url: 'https://raw.githubusercontent.com/openjs-foundation/cross-project-council/240d047d4f2cb135e6c1ce64b036af7aaf639a01/meetings/2023/2023-01-03.md'
           patch_file_path: './patch'
           output_file_path: './CODE_OF_CONDUCT.md'
       - uses: gr2m/create-or-update-pull-request-action@v1

action.yml

@@ -1,9 +1,13 @@
 name: 'Code of Conduct'
 description: 'Generates a Code of Conduct with a prefix and apply necessary patches'
 inputs:
-  base_file_path:
-    description: 'Path of the base markdown file'
+  base_url:
+    description: 'The url to be used for the base'
     required: true
+  template_url:
+    description: URL to be used for the template of the CoC
+    default: https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md
+    required: false
   patch_file_path:
     description: 'Path of the patch to be applied to the output file'
     required: true

lib/index.js

@@ -1,11 +1,12 @@
 const core = require('@actions/core')
 const { apply_patch } = require('./runner.js')
 
-const base_path = core.getInput('base_file_path');
+const base_url = core.getInput('base_url');
+const template_url = core.getInput('template_url');
 const patch_path = core.getInput('patch_file_path');
 const output_path = core.getInput('output_file_path');
 
-apply_patch(base_path, patch_path, output_path)
+apply_patch(base_url, template_url, patch_path, output_path)
   .then(() => core.setOutput('state', 'success'))
   .catch(error => core.setFailed(error))
 

lib/runner.js

@@ -2,13 +2,14 @@ const fs = require('node:fs')
 const { execSync } = require('node:child_process')
 const { fetch } = require('undici')
 
-async function apply_patch(base_path, patch_path, output_path) {
-  if (!fs.existsSync(base_path)) {
-    throw new Error(`base_path (${base_path}) does not exist`)
+async function apply_patch(base_url, template_url, patch_path, output_path) {
+  const base_response = await fetch(base_url);
+
+  if (base_response.status !== 200 && base_response.status !== 201) {
+    throw new Error(`base url response got ${base_url.status} status code. expected 200 or 201.`)
   }
-  const base_text = fs.readFileSync(base_path, 'utf-8');
+  const base_text = await base_response.text();
 
-  const template_url = 'https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md';
   const template_response = await fetch(template_url);
 
   if (template_response.status !== 200 && template_response.status !== 201) {

package.json

@@ -14,9 +14,9 @@
   "author": "Yagiz Nizipli <[email protected]>",
   "license": "MIT",
   "devDependencies": {
-    "@types/node": "^18.11.13",
+    "@types/node": "^18.11.18",
     "@vercel/ncc": "^0.36.0",
-    "vitest": "^0.25.7"
+    "vitest": "^0.26.3"
   },
   "dependencies": {
     "@actions/core": "^1.10.0",

test/apply.test.ts

@@ -4,51 +4,22 @@ import {random_filename, write_file, remove_file, read_file, __dirname} from "./
 import {apply_patch} from '../lib/runner.js'
 
 beforeEach(async (context) => {
-  context.base_path = random_filename()
+  context.base_url = 'https://raw.githubusercontent.com/pkgjs/patch-my-code-of-conduct/cd136b70909ad4c14d738d0399e09559ca2a3ecd/template/base.md'
+  context.template_url = 'https://www.contributor-covenant.org/version/2/1/code_of_conduct/code_of_conduct.md';
   context.patch_path = random_filename()
   context.output_path = random_filename()
 
-  await write_file(context.base_path)
   await write_file(context.patch_path)
   await write_file(context.output_path)
 
   return async () => {
-    await remove_file(context.base_path)
     await remove_file(context.patch_path)
     await remove_file(context.output_path)
   }
 })
 
 test('should add base as prefix', async (context) => {
-  await write_file(context.base_path, 'this is a prefix')
-  await apply_patch(context.base_path, context.patch_path, context.output_path)
+  await apply_patch(context.base_url, context.template_url, context.patch_path, context.output_path)
   const output = await read_file(context.output_path)
-  assert.isTrue(output.startsWith('this is a prefix\n'))
-})
-
-test('should apply the patch', async (context) => {
-  const base_path = path.join(__dirname, '../test/fixture/base.md');
-  const patch_path = path.join(__dirname, '../test/fixture/patch.txt');
-  const output_path = path.join(__dirname, '../test/fixture/output.md');
-
-  await remove_file(output_path);
-
-  const title = `CHANGED THE TITLE OF COC`
-  const patch_text = `--- /dev/null	2022-11-11 18:00:48
-+++ output.md	2022-11-11 18:00:32
-@@ -43,7 +43,7 @@
-
- ---
-
--# ${title}
-+# Contributor Covenant Code of Conduct
-
- ## Our Pledge
-
-`
-  await write_file(patch_path, patch_text)
-
-  await apply_patch(base_path, patch_path, output_path)
-  const output = await read_file(output_path)
-  assert.isTrue(output.includes(title))
+  assert.isTrue(output.startsWith('This is the beginning of our Code of Conduct.\n'))
 })

test/fixture/base.md

@@ -1,11 +1,10 @@
 --- /dev/null	2022-11-11 18:00:48
 +++ output.md	2022-11-11 18:00:32
-@@ -43,7 +43,7 @@
-
- ---
-
--# CHANGED THE TITLE OF COC
-+# Contributor Covenant Code of Conduct
-
+@@ -1,6 +1,6 @@
+ This is the beginning of our Code of Conduct.
+ 
+-# Contributor Covenant Code of Conduct
++# CHANGED_THE_TITLE
+ 
  ## Our Pledge
-
+