From e75264ff163bcfecefb20dead95b291f9ec53a7b Mon Sep 17 00:00:00 2001 From: Ethan Davidson <31261035+EthanThatOneKid@users.noreply.github.com> Date: Thu, 25 May 2023 10:56:11 -0700 Subject: [PATCH 01/10] Update GETTING_STARTED.md --- GETTING_STARTED.md | 54 +++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 4f8fd6060..6d5b5ac09 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -1,50 +1,50 @@ ## Getting started -1. Install [Node 16 LTS](https://nodejs.org/en/) -1. Install [Git](https://git-scm.com/downloads) +1. Install [Node.js](https://nodejs.org/en/) (LTS version). +1. Install [Git](https://git-scm.com/downloads). - If you are not comfortable with the Git command line tool, you may use GitHub Desktop (). Take a look at if this is your first time contributing to an open source project. 1. Create a fork of [acmcsuf.com](https://github.com/EthanThatOneKid/acmcsuf.com), similar to -1. Create an [access token](https://scribehow.com/shared/Generating_a_personal_access_token__eMf0UJYaS5OcGrO_lJTpGg) -1. Follow [these instructions](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/CONTRIBUTING.md#setting-up-your-env-file) to add it to your dev environment +1. (Optional; required on some pages) Create an [access token](https://scribehow.com/shared/Generating_a_personal_access_token__eMf0UJYaS5OcGrO_lJTpGg). +1. Follow [these instructions](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/CONTRIBUTING.md#setting-up-your-env-file) to add it to your dev environment. ## Local development setup -1. Create a local clone of your **FORKED** repository -1. Open a terminal inside your local clone and run `npm i` to install the required dependencies (We use svelte for much of the codebase along with Typescript and some utility libraries) -1. Run `npm start` (or `npm run dev`) to boot up the local development server and navigate to `localhost:5173` in your web browser and you should have a local copy of the website +1. Create a local clone of your **FORKED** repository. +1. Open a terminal inside your local clone and run `npm i` to install the required dependencies (We use svelte for much of the codebase along with Typescript and some utility libraries). +1. Run `npm start` (or `npm run dev`) to boot up the local development server and navigate to `localhost:5173` in your web browser and you should have a local copy of the website. ## Pushing a code change -1. Create a new branch, **DO NOT** work directly off the main branch -1. Open `src/routes/+page.svelte`, this is the root of the website, in other words, the front page when you visit the website -1. Go ahead and change the title of the website to anything you want and head over to `src/routes/hero.svelte` and change the text of the header -1. Whenever applicable (it’s not in this case), write unit tests for any new functions or components you create -1. Once you’re satisfied your changes, you **MUST** use `npm run all` to run all tests, lints, and formatting necessary for a release build, otherwise the automated build test will fail -1. Commit and push your changes +1. Create a new branch, **DO NOT** work directly off the main branch. +1. Open `src/routes/+page.svelte`, this is the root of the website, in other words, the front page when you visit the website. +1. Go ahead and change the title of the website to anything you want and head over to `src/routes/hero.svelte` and change the text of the header. +1. Whenever applicable (it’s not in this case), write unit tests for any new functions or components you create. +1. Once you’re satisfied your changes, you **MUST** use `npm run all` to run all tests, lints, and formatting necessary for a release build, otherwise the automated build test will fail. +1. Commit and push your changes. ## Submitting a pull request for review -1. Once you’re ready to submit your changes for review, head back over to the [main repository](https://github.com/EthanThatOneKid/acmcsuf.com) and click on Pull Requests → New pull request -1. Your pull request should contain - 1. A clear and descriptive title (Please do not use “Fixed #123”) - 1. A clear description that describes, in detail, what you changed and how - 1. A link to the issue that you resolved (if applicable) - 1. Any screenshots if your change affects something visible on the website or that you believe would help the reviewer understand your changes - 1. Examples of good PRs +1. Once you’re ready to submit your changes for review, head back over to the [main repository](https://acmcsuf.com/code) and click on Pull Requests → New pull request. +1. Your pull request should contain. + 1. A clear and descriptive title (Please do not use "Fixed #123"). + 1. A clear description that describes, in detail, what you changed and how. + 1. A link to the issue that you resolved (if applicable). + 1. Any screenshots if your change affects something visible on the website or that you believe would help the reviewer understand your changes. + 1. Examples of good PRs: 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/477](https://github.com/EthanThatOneKid/acmcsuf.com/pull/477) 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/469](https://github.com/EthanThatOneKid/acmcsuf.com/pull/469) 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/401](https://github.com/EthanThatOneKid/acmcsuf.com/pull/401) - 1. Examples of bad PRs + 1. Examples of bad PRs: 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/359](https://github.com/EthanThatOneKid/acmcsuf.com/pull/359) 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/357](https://github.com/EthanThatOneKid/acmcsuf.com/pull/357) -1. Request a code review from someone by first contacting them and then assigning them to your PR using the “Reviewers” panel -1. Address any feedback from your reviewers if applicable -1. Once your changes have been approved, you have permission to merge your changes, and your changes should be merged with a **SQUASH** and **NOT** a merge commit +1. Request a code review from someone by first contacting them and then assigning them to your PR using the "Reviewers" panel. +1. Address any feedback from your reviewers if applicable. +1. Once your changes have been approved, you have permission to merge your changes, and your changes should be merged with a **SQUASH** and **NOT** a merge commit. ## Further reading -If you aren’t already familiar with Svelte, you should go through the official [Svelte tutorial](https://svelte.dev/tutorial/basics) as much of the codebase uses it +If you aren’t already familiar with Svelte, you should go through the official [Svelte tutorial](https://svelte.dev/tutorial/basics), as much of the codebase uses it. -Once you’re ready to start, you may either assign yourself to an issue or ask for an issue to be assigned to you. I’d recommend starting with issues tagged [“Good First Issue”](https://github.com/EthanThatOneKid/acmcsuf.com/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) +Once you’re ready to start, you may either assign yourself to an issue or ask for an issue to be assigned to you. I’d recommend starting with issues tagged [“Good First Issue”](https://github.com/EthanThatOneKid/acmcsuf.com/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22). -For a more in depth overview of the codebase, check out [CONTRIBUTING.md](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/CONTRIBUTING.md) and [ARCHITECTURE.md](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/ARCHITECTURE.md) +For a more in depth overview of the codebase, check out [CONTRIBUTING.md](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/CONTRIBUTING.md) and [ARCHITECTURE.md](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/ARCHITECTURE.md). From 6b207a978d2b732489ba4b60989337244dd8dfc2 Mon Sep 17 00:00:00 2001 From: Ethan Davidson <31261035+EthanThatOneKid@users.noreply.github.com> Date: Thu, 25 May 2023 10:58:27 -0700 Subject: [PATCH 02/10] Update GETTING_STARTED.md --- GETTING_STARTED.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 6d5b5ac09..6bff3aa94 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -31,12 +31,12 @@ 1. A link to the issue that you resolved (if applicable). 1. Any screenshots if your change affects something visible on the website or that you believe would help the reviewer understand your changes. 1. Examples of good PRs: - 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/477](https://github.com/EthanThatOneKid/acmcsuf.com/pull/477) - 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/469](https://github.com/EthanThatOneKid/acmcsuf.com/pull/469) - 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/401](https://github.com/EthanThatOneKid/acmcsuf.com/pull/401) + 1. [https://acmcsuf.com/pull/477](https://github.com/EthanThatOneKid/acmcsuf.com/pull/477) + 1. [https://acmcsuf.com/pull/469](https://github.com/EthanThatOneKid/acmcsuf.com/pull/469) + 1. [https://acmcsuf.com/pull/401](https://github.com/EthanThatOneKid/acmcsuf.com/pull/401) 1. Examples of bad PRs: - 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/359](https://github.com/EthanThatOneKid/acmcsuf.com/pull/359) - 1. [https://github.com/EthanThatOneKid/acmcsuf.com/pull/357](https://github.com/EthanThatOneKid/acmcsuf.com/pull/357) + 1. [https://acmcsuf.com/pull/359](https://github.com/EthanThatOneKid/acmcsuf.com/pull/359) + 1. [https://acmcsuf.com/pull/357](https://github.com/EthanThatOneKid/acmcsuf.com/pull/357) 1. Request a code review from someone by first contacting them and then assigning them to your PR using the "Reviewers" panel. 1. Address any feedback from your reviewers if applicable. 1. Once your changes have been approved, you have permission to merge your changes, and your changes should be merged with a **SQUASH** and **NOT** a merge commit. From 6157bd60e145d8abd0a45cffb382c08d07cc9282 Mon Sep 17 00:00:00 2001 From: EthanThatOneKid <31261035+EthanThatOneKid@users.noreply.github.com> Date: Sun, 2 Jul 2023 12:31:33 -0700 Subject: [PATCH 03/10] Fix heading capitalization --- CONTRIBUTING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 19b177444..27acf9886 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing 🤝 -## Getting Started 🦕 +## Getting started 🦕 Getting started with this project is similar to any other Node.js project. There really are only a handful of simple steps. @@ -22,7 +22,7 @@ Every update made to the source code will trigger your `http://localhost:5173/` Now that you've got everything up-and-running, you are free to contribute to your heart's content. -## Submitting your own Contributions 🎉 +## Submitting your own contributions 🎉 Before publishing a PR, it is required that you run `npm run all` to make sure that you are complying with our style guidelines and passing all checks. @@ -55,7 +55,7 @@ npm run host npm run test:coverage ``` -### NPM Bloat +### NPM bloat In this project, we set a threshold for how large the `/node_modules` folder can become after an `npm install`. In our [`package.json`](package.json), we set the size to 50 MB. @@ -66,9 +66,9 @@ To test the size of the dependencies in your local workspace, run `npm run test: For architecture-related information, please refer to [`ARCHITECTURE.md`](ARCHITECTURE.md). -## Svelte File Structure 📄 +## Svelte file structure 📄 -Svelte files can be written as if it were an HTML file. +[Svelte][svelte_home] files can be written as if it were an HTML file. Writing only `

Hello, world!

` in a Svelte file is valid, however, Svelte gives you access to some handy built-in superpowers that simplify development tremendously (See the [Svelte docs][svelte_docs] for further information). Additionally, check out this YouTube video, [_Svelte in 100 Seconds_](https://youtu.be/rv3Yq-B8qp4) by [**@fireship-io**](https://github.com/fireship-io). For quick reference, check out . @@ -138,11 +138,11 @@ HUB_ID=YOUR_HUB_CHANNEL_ID ARCHIVE_CHANNEL_ID=YOUR_ARCHIVE_CHANNEL_ID ``` -## Custom Workflows +## Custom workflows In this repository, we use GitHub Actions to _automate all the things_ 😎 -### Creating an Officer Update Request +### Creating an officer update request To update the way an officer appears on , contributors may fill out our [**Officer Update Request Form**](https://github.com/EthanThatOneKid/acmcsuf.com/issues/new?assignees=&labels=automation%3Aofficer&template=officer_update_request.yaml&title=%5BOFFICER_AUTOMATION%5D) ([source](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/.github/ISSUE_TEMPLATE/officer_update_request.yaml)) to automate a pull request with the requested changes. @@ -155,13 +155,13 @@ Finally, contributors can also remove an officer from the officers list by typin Once a contributor has submitted the issue form, a new PR should be available momentarily for preview. Contributors are free to merge the auto-generated pull request if it seems to have made the intended changes. -#### How it Works +#### How it works The [`workflows/update_officer.yaml`](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/.github/workflows/update_officer.yaml) workflow configuration automates each time an issue is opened with the `automation:officer` label. This workflow relies on [`scripts/update-officer.js`](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/scripts/update-officer.js) to make the appropriate changes to the checked-out codebase (including updating the repo's `officers.json` file or adding/replacing their image in the repo's `/static/assets/authors/` directory). Then, the workflow generates a pull request based on the changes made by the `update-officer.js` script and immediately closes the issue. -### Automated Third-Party Message Board +### Automated third-party message board Our team uses Discord as our third-party messaging service of choice to discuss relevant topics that aren't suited/ready for GitHub. We have text channels set up on Discord dedicated to every open issue on GitHub. @@ -177,7 +177,7 @@ This workflow relies on [`scripts/create-issue-channel.js`](https://github.com/E The [`workflows/close_issue_channel.yaml`](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/.github/workflows/close_issue_channel.yaml) workflow is responsible for closing a text channel whenever a corresponding issue is closed [or deleted] on Github. This workflow relies on [`scripts/close-issue-channel.js`](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/scripts/close-issue-channel.js) to transcribe the old issue channel's messages to a dedicated _archive_ channel and then delete the old channel. -## Webmaster's Note 📝 +## Webmaster's note 📝 Thank you for contributing! The time spent reading this deserves a pat on the back and even a hydration/stretch break. From bae04fae9aba974f19a9f0193c5b5231e799ee2f Mon Sep 17 00:00:00 2001 From: EthanThatOneKid <31261035+EthanThatOneKid@users.noreply.github.com> Date: Thu, 6 Jul 2023 10:43:28 -0700 Subject: [PATCH 04/10] Add "Updating board member data" Edit "Custom workflows", add "Updating board member data" --- CONTRIBUTING.md | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 27acf9886..e5360f844 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -138,28 +138,17 @@ HUB_ID=YOUR_HUB_CHANNEL_ID ARCHIVE_CHANNEL_ID=YOUR_ARCHIVE_CHANNEL_ID ``` -## Custom workflows - -In this repository, we use GitHub Actions to _automate all the things_ 😎 - -### Creating an officer update request +SS## Updating board member data -To update the way an officer appears on , contributors may fill out our [**Officer Update Request Form**](https://github.com/EthanThatOneKid/acmcsuf.com/issues/new?assignees=&labels=automation%3Aofficer&template=officer_update_request.yaml&title=%5BOFFICER_AUTOMATION%5D) ([source](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/.github/ISSUE_TEMPLATE/officer_update_request.yaml)) to automate a pull request with the requested changes. +To update the way an officer appears on , contributors may directly edit our `src/lib/public/board/data/officers.json` JSON file. -A contributor is able to update an acmCSUF officer's image by simply opening a new [**Officer Update Request Form**](https://github.com/EthanThatOneKid/acmcsuf.com/issues/new?assignees=&labels=automation%3Aofficer&template=officer_update_request.yaml&title=%5BOFFICER_AUTOMATION%5D) and pasting the updated officer image into the provided textarea. +Alternatively board members may update their own board member data using a Discord slash command `/boardd` in our official club Discord server. For more information, see . -A contributor is also able to update the position title of an acmCSUF officer for a given _term_ (e.g. Fall 2021, Spring 2022, etc.). +out our [**Officer Update Request Form**](https://github.com/EthanThatOneKid/acmcsuf.com/issues/new?assignees=&labels=automation%3Aofficer&template=officer_update_request.yaml&title=%5BOFFICER_AUTOMATION%5D) ([source](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/.github/ISSUE_TEMPLATE/officer_update_request.yaml)) to automate a pull request with the requested changes. -Finally, contributors can also remove an officer from the officers list by typing `DELETE` into the _Overwrite Officer Position Title_ field. - -Once a contributor has submitted the issue form, a new PR should be available momentarily for preview. -Contributors are free to merge the auto-generated pull request if it seems to have made the intended changes. - -#### How it works +## Custom workflows -The [`workflows/update_officer.yaml`](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/.github/workflows/update_officer.yaml) workflow configuration automates each time an issue is opened with the `automation:officer` label. -This workflow relies on [`scripts/update-officer.js`](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/scripts/update-officer.js) to make the appropriate changes to the checked-out codebase (including updating the repo's `officers.json` file or adding/replacing their image in the repo's `/static/assets/authors/` directory). -Then, the workflow generates a pull request based on the changes made by the `update-officer.js` script and immediately closes the issue. +In this repository, we use GitHub Actions to _automate all the things_ 😎 ### Automated third-party message board From 24e54d0e8a43b101bdc2a973add4ec1206957805 Mon Sep 17 00:00:00 2001 From: EthanThatOneKid <31261035+EthanThatOneKid@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:35:49 -0700 Subject: [PATCH 05/10] Include periods on complete sentences Resolves . --- GETTING_STARTED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 4e41d5e87..9fe41a5bd 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -3,7 +3,7 @@ 1. Install [Node.js](https://nodejs.org/en/) (LTS version). 1. Install [Git](https://git-scm.com/downloads). - If you are not comfortable with the Git command line tool, you may use GitHub Desktop (). Take a look at if this is your first time contributing to an open source project. -1. Create a fork of [acmcsuf.com](https://github.com/EthanThatOneKid/acmcsuf.com), similar to +1. Create a fork of [acmcsuf.com](https://github.com/EthanThatOneKid/acmcsuf.com), similar to . 1. (Optional; required on some pages) Create an [access token](https://scribehow.com/shared/Generating_a_personal_access_token__eMf0UJYaS5OcGrO_lJTpGg). 1. Follow [these instructions](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/CONTRIBUTING.md#setting-up-your-env-file) to add it to your dev environment. From 9a0a50f2155db7427c8ae5fb7a6d253b11cabe28 Mon Sep 17 00:00:00 2001 From: EthanThatOneKid <31261035+EthanThatOneKid@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:36:09 -0700 Subject: [PATCH 06/10] Fix "Getting started" title --- GETTING_STARTED.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 9fe41a5bd..5efe16dfc 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -1,4 +1,4 @@ -## Getting started +# Getting started 1. Install [Node.js](https://nodejs.org/en/) (LTS version). 1. Install [Git](https://git-scm.com/downloads). From 82d1a77b696bccfc0117a29fea76c71565501cdd Mon Sep 17 00:00:00 2001 From: EthanThatOneKid <31261035+EthanThatOneKid@users.noreply.github.com> Date: Wed, 6 Sep 2023 21:50:45 -0700 Subject: [PATCH 07/10] Getting started: clarify review cycle Resolves . --- GETTING_STARTED.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/GETTING_STARTED.md b/GETTING_STARTED.md index 5efe16dfc..51fa677e2 100644 --- a/GETTING_STARTED.md +++ b/GETTING_STARTED.md @@ -37,8 +37,9 @@ 1. Examples of bad PRs: 1. [https://acmcsuf.com/pull/359](https://github.com/EthanThatOneKid/acmcsuf.com/pull/359) 1. [https://acmcsuf.com/pull/357](https://github.com/EthanThatOneKid/acmcsuf.com/pull/357) -1. Request a code review from someone by first contacting them and then assigning them to your PR using the "Reviewers" panel. -1. Address any feedback from your reviewers if applicable. +1. Use the "Reviewers" panel on the top-right side of the PR page to request a review. Reach out to your chosen reviewer outside of GitHub to ensure they are aware of your code review request. +1. As a requester, it is courteous to give your chosen reviewer a heads-up before formally requesting a review. As a reviewer, it is also common courtesy to respond to code review requests within 24 hours. +1. If your chosen reviewer does not review your code within 24 hours, consider gently reminding them. Alternatively, if necessary, you can request a review from another individual. 1. Once your changes have been approved, you have permission to merge your changes, and your changes should be merged with a **SQUASH** and **NOT** a merge commit. ## Further reading From 6f8e7658b80ff5fd5b5536f96d768111cd08bbce Mon Sep 17 00:00:00 2001 From: EthanThatOneKid <31261035+EthanThatOneKid@users.noreply.github.com> Date: Wed, 6 Sep 2023 22:02:56 -0700 Subject: [PATCH 08/10] CONTRIBUTING.md: add shortlinks and blog posts --- CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e5360f844..4c929de54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -138,7 +138,7 @@ HUB_ID=YOUR_HUB_CHANNEL_ID ARCHIVE_CHANNEL_ID=YOUR_ARCHIVE_CHANNEL_ID ``` -SS## Updating board member data +## Updating board member data To update the way an officer appears on , contributors may directly edit our `src/lib/public/board/data/officers.json` JSON file. @@ -146,6 +146,17 @@ Alternatively board members may update their own board member data using a Disco out our [**Officer Update Request Form**](https://github.com/EthanThatOneKid/acmcsuf.com/issues/new?assignees=&labels=automation%3Aofficer&template=officer_update_request.yaml&title=%5BOFFICER_AUTOMATION%5D) ([source](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/.github/ISSUE_TEMPLATE/officer_update_request.yaml)) to automate a pull request with the requested changes. +## Updating shortlinks + +To update the shortlinks, contributors may directly edit the `src/lib/public/links/links.json` JSON file. + +Alternatively, board members may update the shortlinks using a Discord slash command `/shorter` in our official club Discord server. For more information, see . + + +## Updating blog posts + + posts are stored via GitHub Discussions on the acmcsuf.com repository's [`Newsletter` category](https://github.com/EthanThatOneKid/acmcsuf.com/discussions/categories/newsletter). Edit existing blog posts by editing the corresponding discussion. Create new blog posts by creating a new discussion in the `Newsletter` category (). + ## Custom workflows In this repository, we use GitHub Actions to _automate all the things_ 😎 From c996bad4d126f241580ae6a12e504c63d14d46ba Mon Sep 17 00:00:00 2001 From: EthanThatOneKid <31261035+EthanThatOneKid@users.noreply.github.com> Date: Wed, 6 Sep 2023 22:04:27 -0700 Subject: [PATCH 09/10] Remove legacy `update_officer.yaml` workflow --- .../officer_update_request.yaml | 88 ------------------- .github/workflows/update_officer.yaml | 55 ------------ 2 files changed, 143 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/officer_update_request.yaml delete mode 100644 .github/workflows/update_officer.yaml diff --git a/.github/ISSUE_TEMPLATE/officer_update_request.yaml b/.github/ISSUE_TEMPLATE/officer_update_request.yaml deleted file mode 100644 index ce5705035..000000000 --- a/.github/ISSUE_TEMPLATE/officer_update_request.yaml +++ /dev/null @@ -1,88 +0,0 @@ -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 . - 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: '>>Term to Overwrite<<' - 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: dropdown - id: officer_tier - attributes: - label: '>>Overwrite Officer Position Tier<<' - description: Please enter the tier of the officer's position. - options: - - 'President' - - 'Vice President' - - 'Secretary' - - 'Treasurer' - - 'Webmaster' - - 'Data Analyst' - - 'Event Coordinator' - - 'Marketing Director' - - 'Historian' - - 'Algo President' - - 'Algo Officer' - - 'Create President' - - 'Create Officer' - - 'Create Project Developer' - - 'Create Operations Manager' - - 'Dev President' - - 'Dev Officer' - - 'Dev Project Manager' - - 'Deprecated Position' - 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 - - - type: input - id: officer_displayname - attributes: - label: '>>Overwrite Officer GitHub Username<<' - description: Please enter the GitHub username of the officer's position. - validations: - required: false diff --git a/.github/workflows/update_officer.yaml b/.github/workflows/update_officer.yaml deleted file mode 100644 index dd6ec1fda..000000000 --- a/.github/workflows/update_officer.yaml +++ /dev/null @@ -1,55 +0,0 @@ -name: Update Officer Data - -on: - issues: - types: [opened, reopened] - -jobs: - update_officer: - runs-on: ubuntu-latest - if: ${{ contains(github.event.issue.labels.*.name, 'automation:officer') }} - steps: - - name: Checkout - uses: actions/checkout@v2 - - - name: Parse Issue Form - id: parse - uses: peter-murray/issue-forms-body-parser@v2.0.0 - 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: Install Dependencies - run: npm ci - - - run: node scripts/update-officer.js - env: - FORM_DATA: ${{ steps.parse.outputs.payload }} - - - name: Expose Officer Name - id: officer-name - uses: actions/github-script@v5 - with: - script: return JSON.parse(process.env["FORM_DATA"])["Officer Name"] - result-encoding: string - env: - FORM_DATA: ${{ steps.parse.outputs.payload }} - - - name: Create Pull Request - id: pull_request - uses: peter-evans/create-pull-request@v4.1.1 - with: - commit-message: Updated officer data - title: 'Add/Update officer ${{ steps.officer-name.outputs.result }}' - branch: 'automation/${{ github.event.issue.number }}' - body: | - This PR was automatically generated by our [`update_officer.yaml`](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/.github/workflows/update_officer.yaml) workflow. For more info, see [`CONTRIBUTING.md`](https://github.com/EthanThatOneKid/acmcsuf.com/blob/main/CONTRIBUTING.md#creating-an-officer-update-request). - - Resolves \#${{ github.event.issue.number }} ✨ From 17ba0c77e1e31754dd2f4eb34cbb8c4e5c24293b Mon Sep 17 00:00:00 2001 From: EthanThatOneKid <31261035+EthanThatOneKid@users.noreply.github.com> Date: Wed, 6 Sep 2023 22:10:57 -0700 Subject: [PATCH 10/10] Run `npm run all` --- CONTRIBUTING.md | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c929de54..43d51c879 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,7 +152,6 @@ To update the shortlinks, contributors may directly edit the `src/lib/public/lin Alternatively, board members may update the shortlinks using a Discord slash command `/shorter` in our official club Discord server. For more information, see . - ## Updating blog posts posts are stored via GitHub Discussions on the acmcsuf.com repository's [`Newsletter` category](https://github.com/EthanThatOneKid/acmcsuf.com/discussions/categories/newsletter). Edit existing blog posts by editing the corresponding discussion. Create new blog posts by creating a new discussion in the `Newsletter` category ().