Created officer data workflow

.github/ISSUE_TEMPLATE/officer_update_request.yaml

@@ -0,0 +1,52 @@
+name: Officer Update Request
+description: Here is where you can update an acmCSUF officer's information.
+title: '[OFFICER_AUTOMATION]'
+labels: ['automation:officer']
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        ### About this form
+        When you submit this form, an automation is triggered that creates a PR updating the user data on <https://acmcsuf.com/about/>.
+        This form only triggers a workflow if you are an authorized contributor.
+        ![banner](https://raw.githubusercontent.com/EthanThatOneKid/acmcsuf.com/main/static/assets/about-illustration.svg)
+        **Note**: Above banner not included in your published bug report.
+
+  - type: input
+    id: officer_name
+    attributes:
+      label: '>>Officer Name<<'
+      description: Please enter the name of the officer as seen on https://acmcsuf.com/about/.
+    validations:
+      required: true
+
+  - type: dropdown
+    id: officer_term
+    attributes:
+      label: '>>Overwrite Officer Position<<'
+      options:
+        - Spring 2021
+        - Fall 2021
+        - Spring 2022
+        - Fall 2022
+    validations:
+      required: false
+
+  - type: input
+    id: officer_position
+    attributes:
+      label: '>>Overwrite Officer Position Title<<'
+      description: Please enter the new title of the officer's position during the term selected above.
+    validations:
+      required: false
+
+  - type: textarea
+    id: officer_image
+    attributes:
+      label: '>>Overwrite Officer Picture<<'
+      description: |
+        If an image is detected inside of this textarea, it will be used to update the officer's image on the website.
+      placeholder: You can attach images by clicking this area to highlight it and then dragging files in.
+    validations:
+      required: false

.github/workflows/update_officer.yaml

@@ -0,0 +1,60 @@
+name: Update Officer Data
+
+on:
+  issues:
+    types: [opened, reopened]
+
+jobs:
+  update_officer:
+    runs-on: ubuntu-latest
+    if: github.event.label.name == 'automation:officer'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Parse Issue Form
+        id: parse
+        uses: peter-murray/[email protected]
+        with:
+          issue_id: ${{ github.event.issue.number }}
+          separator: '###'
+          label_marker_start: '>>'
+          label_marker_end: '<<'
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '16'
+
+      - name: Run Update Officer Script
+        run: npm ci
+        run: node scripts/update-officer.js "${{ steps.parse.outputs.payload }}"
+
+      - name: Create Pull Request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          commit-message: Updated officer data
+          title: '[OFFICER_AUTOMATION]'
+          body: This change was automated by officer update request \#${{ github.event.issue.number }} ✨
+
+      - name: Install Dependencies
+        run: npm ci
+
+      - run: node scripts/update-officer.js
+        env:
+          FORM_DATA: ${{ steps.parse.outputs.payload }}
+
+      - name: Create Pull Request
+        id: pull_request
+        uses: peter-evans/create-pull-request@v3
+        with:
+          commit-message: Update officer
+          title: Update officer
+          body: Process automated by \#${{ github.event.issue.number }}
+          branch: update-officers
+
+      - name: Close Issue
+        id: close_successfully
+        uses: peter-evans/close-issue@v1
+        with:
+          issue-number: ${{ github.event.issue.number }}
+          comment: Closed by \#${{ steps.pull_request.outputs.pull-request-number }} ✨

package.json

@@ -30,6 +30,7 @@
     "@sveltejs/kit": "next",
     "@typescript-eslint/eslint-plugin": "^4.31.1",
     "@typescript-eslint/parser": "^4.31.1",
+    "axios": "^0.24.0",
     "discord.js": "^13.2.0",
     "dotenv": "^10.0.0",
     "eslint": "^7.32.0",

scripts/update-officer.js

@@ -0,0 +1,103 @@
+import axios from 'axios';
+import { config } from 'dotenv';
+import { readFileSync, writeFileSync, createWriteStream } from 'fs';
+
+/**
+ * Example officer data:
+ * ```json
+ * {
+ *	"name": "Ethan Davidson",
+ *	"positions": {
+ *		"F20": "Competition Manager",
+ *		"S21": "Webmaster",
+ *		"F21": "Webmaster"
+ *	},
+ *	"picture": "ethan-davidson.png"
+ * }
+ *```
+ */
+const OFFICERS_FILENAME = './src/lib/constants/officers.json';
+
+/**
+ * Converts 'Fall 2021' to 'F21', 'Spring 2022' to 'S22, etc.
+ */
+const termAbbr = (term) =>
+  term === undefined ? null : (term.startsWith('F') ? 'F' : 'S') + term.slice(term.length - 2);
+
+/**
+ * Parses the first instance of an image URL from a markdown string.
+ */
+const parseImgSrcFromMd = (markdown) => {
+  // https://regex101.com/r/cSbfvF/3/
+  const pattern = /!\[[^\]]*\]\((?<filename>.*?)(?="|\))(?<optionalpart>".*")?\)/i;
+  const match = pattern.exec(markdown);
+  if (match === null) return null;
+  return match.groups.filename;
+};
+
+const downloadOfficerImage = async (url, officerName) => {
+  const cleanOfficerName = officerName.trim().toLowerCase().replace(/\s/g, '-');
+  const filename = `${encodeURIComponent(cleanOfficerName)}.png`;
+  const imagePath = `./static/assets/authors/${filename}`;
+  const response = await axios({ url, responseType: 'stream' });
+  return await new Promise((resolve, reject) =>
+    response.data
+      .pipe(createWriteStream(imagePath))
+      .on('finish', () => resolve(filename))
+      .on('error', reject)
+  );
+};
+
+const updateOfficer = async () => {
+  const result = JSON.parse(readFileSync(OFFICERS_FILENAME));
+  const {
+    ['Officer Name']: name,
+    ['Term to Overwrite']: term,
+    ['Overwrite Officer Position Title']: title,
+    ['Overwrite Officer Picture']: picture,
+  } = JSON.parse(process.env.FORM_DATA);
+  const isValidName = name?.trim().length > 0 ?? false;
+  if (!isValidName) {
+    console.error(`received invalid officer name, ${name}`);
+    return false;
+  }
+  const abbreviatedTerm = termAbbr(term);
+  if (abbreviatedTerm === null) {
+    console.error(`received invalid term, '${term}'`);
+    return false;
+  }
+  let officerIndex = result.findIndex((officer) => officer.name === name);
+  if (officerIndex === -1) {
+    // officer name not found, so let's create a new officer
+    result.push({ name });
+    officerIndex = result.length - 1;
+  }
+  const titleNeedsUpdate = title !== undefined && title.trim().length > 0;
+  if (titleNeedsUpdate) {
+    if (title === 'DELETE') delete result[officerIndex].positions[abbreviatedTerm];
+    else result[officerIndex].positions[abbreviatedTerm] = title.trim();
+  }
+  const pictureNeedsUpdate = picture !== undefined && picture.trim().length > 0;
+  if (pictureNeedsUpdate) {
+    const imgSrc = parseImgSrcFromMd(picture);
+    if (imgSrc === null) {
+      console.error(`received invalid officer picture '${picture}'`);
+      return false;
+    }
+    const relativeImgSrc = await downloadOfficerImage(imgSrc, name);
+    if (typeof relativeImgSrc === 'string') result[officerIndex].picture = relativeImgSrc;
+  }
+  console.log(`${name.trim()}'s updated officer data: `, result[officerIndex]);
+  writeFileSync(OFFICERS_FILENAME, JSON.stringify(result, null, 2));
+  return true;
+};
+
+try {
+  config();
+  const success = await updateOfficer();
+  if (success) process.exit(0);
+} catch (error) {
+  console.error(error);
+}
+
+process.exit(1);