Update gha pr instructions 5165

.github/workflows/wr-pr-instructions.yml

@@ -41,7 +41,7 @@ jobs:
             // Retrieve pull request and issue number from downloaded artifact
             const fs = require('fs')
             const artifact = fs.readFileSync('artifact.txt')
-            const artifactJSON = JSON.parse(artifact);
+            const artifactJSON = JSON.parse(artifact)
             return artifactJSON
 
       - uses: actions/checkout@v3

github-actions/pr-instructions/create-instruction.js

@@ -1,30 +1,56 @@
 // Global variables
 var github;
 var context;
+const fs = require('fs');
 
 /**
  * Uses information from the pull request to create commandline instructions.
  * @param {Object} g - github object
  * @param {Object} c - context object
- * @returns {string} string containing commandline instructions
+ * @returns {string} string containing commandline instructions, URI encoded since the backtick character is not allowed in *  artifact
  */
 function main({ g, c }) {
     github = g;
     context = c;
-    return createInstruction();
+    return encodeURI(compositeInstruction());   
 }
 
-function createInstruction() {
+function formatPullComment(instruction) {
+    const path = './github-actions/pr-instructions/pr-instructions-template.md'
+    const text = fs.readFileSync(path).toString('utf-8');
+    const completedInstructions = text.replace('${commandlineInstructions}', instruction);
+    return completedInstructions;
+}
+
+function formatContribComment(instruction){
+	const path = './github-actions/pr-instructions/pr-instructions-contrib-template.md'
+    const text = fs.readFileSync(path).toString('utf-8');
+    const completedInstructions = text.replace('${previewContribInstructions}', instruction);
+    return completedInstructions;
+}
+
+function createPullInstruction(){
     const nameOfCollaborator = context.payload.pull_request.head.repo.owner.login;
     const nameOfFromBranch = context.payload.pull_request.head.ref;
     const nameOfIntoBranch = context.payload.pull_request.base.ref;
     const cloneURL = context.payload.pull_request.head.repo.clone_url;
-
-    const instructionString =
+    const pullInstructionString =
 `git checkout -b ${nameOfCollaborator}-${nameOfFromBranch} ${nameOfIntoBranch}
 git pull ${cloneURL} ${nameOfFromBranch}`
+    return pullInstructionString;
+}
+
+function createContribInstruction(){
+	const nameOfCollaborator = context.payload.pull_request.head.repo.owner.login;
+    const nameOfFromBranch = context.payload.pull_request.head.ref;
+	const previewContribURL = `https://github.com/${nameOfCollaborator}/website/blob/${nameOfFromBranch}/CONTRIBUTING.md`
+	return previewContribURL;
+}
 
-    return instructionString
+function compositeInstruction() {
+	const completedPullInstruction = formatPullComment(createPullInstruction());
+	const completedContribInstruction = formatContribComment(createContribInstruction());
+	return completedPullInstruction + completedContribInstruction;
 }
 
 module.exports = main

github-actions/pr-instructions/post-comment.js

@@ -15,17 +15,9 @@ var context;
 async function main({ g, c }, { issueNum, instruction }) {
     github = g;
     context = c;
-
-    const instructions = formatComment(instruction)
-    postComment(issueNum, instructions);
+    postComment(issueNum, decodeURI(instruction));
 }
 
-function formatComment(instruction) {
-    const path = './github-actions/pr-instructions/pr-instructions-template.md'
-    const text = fs.readFileSync(path).toString('utf-8');
-    const completedInstuctions = text.replace('${commandlineInstructions}', instruction)
-    return completedInstuctions
-}
 
 async function postComment(issueNum, instructions) {
     try {

github-actions/pr-instructions/pr-instructions-contrib-template.md

@@ -0,0 +1,9 @@
+<!-- Note: Commandline instructions are added into where the placeholder string first appears --->
+
+-------------------
+
+Note that CONTRIBUTING.md cannot previewed locally; rather it should be previewed at this URL:
+
+```
+${previewContribInstructions}  
+```