CodeyBot - Revision history

Vdnguyen: /* Management/Maintenance (For Termcom only) */

2025-09-13T02:10:54Z

Management/Maintenance (For Termcom only)

← Older revision		Revision as of 21:10, 12 September 2025
Line 8:		Line 8:

	== Management/Maintenance (For Termcom only) ==		== Management/Maintenance (For Termcom only) ==
	Now here comes the fun part. It's fun because there has never been a single documentation on this stuff. But I didn't enjoy that kind of fun. So please read this.		Now here comes the fun part. It is fun because there has never been a single documentation on this stuff. But I didn't enjoy that kind of fun. So please read this.

	=== Repo owners ===		=== Repo owners ===

Vdnguyen: /* Management/Maintenance (For Termcom only) */

2025-07-18T01:15:45Z

Management/Maintenance (For Termcom only)

← Older revision		Revision as of 20:15, 17 July 2025
Line 9:		Line 9:
	== Management/Maintenance (For Termcom only) ==		== Management/Maintenance (For Termcom only) ==
	Now here comes the fun part. It's fun because there has never been a single documentation on this stuff. But I didn't enjoy that kind of fun. So please read this.		Now here comes the fun part. It's fun because there has never been a single documentation on this stuff. But I didn't enjoy that kind of fun. So please read this.

			=== Repo owners ===
			Just make sure you do these 2 things:
			* Update the owner(s) of the CodeyBot repo (if you have to) under https://github.com/orgs/uwcsc/teams/discord. Only the owner can review PRs, approve PRs, merge PRs into <code>main</code> and push code to <code>main</code> without having to make a PR.
			* Update the owner(s) of the CodeyBot repo in <code>.github/CODEOWNERS</code>. By doing this, whenever a PR is made and review is requested, it will default to the right owner(s).

	=== Discord Mod for Ban Appeal ===		=== Discord Mod for Ban Appeal ===

Vdnguyen: /* Historical Note */

2025-07-18T01:04:32Z

Historical Note

← Older revision		Revision as of 20:04, 17 July 2025
Line 2:		Line 2:

	== Historical Note ==		== Historical Note ==
	We used to have a team dedicated to developing CodeyBot within the ~~Organizing~~ Committee, called CodeyBot Developer team. However, as of Fall 2025, in order to make the CSC Committee more efficient and organized, CodeyBot Developer team has been dissolved. The responsibilities of maintaining and developing CodeyBot now falls in the hands of Termcom.		We used to have a team dedicated to developing CodeyBot within the CSC Committee, called CodeyBot Developer team. However, as of Fall 2025, in order to make the CSC Committee more efficient and organized, CodeyBot Developer team has been dissolved. The responsibilities of maintaining and developing CodeyBot now falls in the hands of Termcom.

	== Contribution ==		== Contribution ==

Vdnguyen: /* Discord Mod for Ban Appeal */

2025-07-18T01:01:21Z

Discord Mod for Ban Appeal

← Older revision		Revision as of 20:01, 17 July 2025
Line 11:		Line 11:

	=== Discord Mod for Ban Appeal ===		=== Discord Mod for Ban Appeal ===
	If you haven't noticed already, CSC Committee has Discord Moderators. And like it or not, they need to ban people from CSC server quite frequently. Whenever a server member is banned, they get DM'ed by CodeyBot on why they were banned and who they could get in touch for further details. This who is the team lead of the Discord Moderators. And they might change, from term to term. As such, <b>at the beginning of every term</b>, make sure that the variable <code>MOD_USER_ID_FOR_BAN_APPEAL</code> is set to the Discord user ID of the right person. The variable can be found in <code>config/production/vars.json</code> in the repo.		If you haven't noticed already, CSC Committee has Discord Moderators. And like it or not, they need to ban people from CSC server quite frequently. Whenever a server member is banned, they get DM'ed by CodeyBot on why they were banned and who they could get in touch for further details. This who is usually the team lead of the Discord Moderators. And they might change, from term to term. As such, <b>at the beginning of every term</b>, make sure that the variable <code>MOD_USER_ID_FOR_BAN_APPEAL</code> is set to the Discord user ID of the right person. The variable can be found in <code>config/production/vars.json</code> in the repo.

	=== Hosting ===		=== Hosting ===

Vdnguyen at 01:00, 18 July 2025

2025-07-18T01:00:55Z

← Older revision		Revision as of 20:00, 17 July 2025
Line 9:		Line 9:
	== Management/Maintenance (For Termcom only) ==		== Management/Maintenance (For Termcom only) ==
	Now here comes the fun part. It's fun because there has never been a single documentation on this stuff. But I didn't enjoy that kind of fun. So please read this.		Now here comes the fun part. It's fun because there has never been a single documentation on this stuff. But I didn't enjoy that kind of fun. So please read this.

			=== Discord Mod for Ban Appeal ===
			If you haven't noticed already, CSC Committee has Discord Moderators. And like it or not, they need to ban people from CSC server quite frequently. Whenever a server member is banned, they get DM'ed by CodeyBot on why they were banned and who they could get in touch for further details. This who is the team lead of the Discord Moderators. And they might change, from term to term. As such, <b>at the beginning of every term</b>, make sure that the variable <code>MOD_USER_ID_FOR_BAN_APPEAL</code> is set to the Discord user ID of the right person. The variable can be found in <code>config/production/vars.json</code> in the repo.

	=== Hosting ===		=== Hosting ===

Vdnguyen at 00:45, 18 July 2025

2025-07-18T00:45:25Z

← Older revision		Revision as of 19:45, 17 July 2025
Line 16:		Line 16:
	* <code>codey-bootcamp</code>: a different version of CodeyBot tailored for CSC Bootcamp events (which happens every now and then).		* <code>codey-bootcamp</code>: a different version of CodeyBot tailored for CSC Bootcamp events (which happens every now and then).

	Note: there are discussions to move CodeyBot to <code>caffeine</code> because ~~Cloudstack~~ is not kind. As of this writing, this still remains a discussion.		Note: there are discussions to move CodeyBot to <code>caffeine</code> because CloudStack is not kind. As of this writing, this still remains a discussion.

			=== VM Access ===
			I told you that CodeyBot is hosted on CloudStack. What I did not tell you is that CloudStack is broken. More specifically, you cannot add your own SSH key from the web interface, nor can you access the console from the web interface.

			As such, until CodeyBot is migrated away from CloudStack, make sure there is <b>at least 1 person</b> who already has access to the VMs so that they can give you access to the VMs. Just give them your public SSH key and they can add you to the VMs.

	=== Structure ===		=== Structure ===

Vdnguyen: /* Historical Note */

2025-07-18T00:41:25Z

Historical Note

← Older revision		Revision as of 19:41, 17 July 2025
Line 2:		Line 2:

	== Historical Note ==		== Historical Note ==
	We used to have a team dedicated to developing CodeyBot within the Organizing Committee, called CodeyBot Developer team. However, as of Fall 2025, in order to make the CSC Committee more efficient and organized, CodeyBot Developer has been dissolved. The responsibilities of maintaining and developing CodeyBot now falls in the hands of Termcom.		We used to have a team dedicated to developing CodeyBot within the Organizing Committee, called CodeyBot Developer team. However, as of Fall 2025, in order to make the CSC Committee more efficient and organized, CodeyBot Developer team has been dissolved. The responsibilities of maintaining and developing CodeyBot now falls in the hands of Termcom.

	== Contribution ==		== Contribution ==

Vdnguyen: /* CI/CD pipeline */

2025-07-18T00:39:51Z

CI/CD pipeline

← Older revision		Revision as of 19:39, 17 July 2025
Line 47:		Line 47:
	* Production: Whenever <b>a release is made on GitHub</b>, it triggers the corresponding code in <code>.github/workflows/build.yml</code> that builds the image and uploads it to Docker Hub. Watchtower looks out for image changes every 30 seconds. If the image is updated, Watchtower stops the current CodeyBot container, pulls the latest image, rebuilds the container and starts it up again.		* Production: Whenever <b>a release is made on GitHub</b>, it triggers the corresponding code in <code>.github/workflows/build.yml</code> that builds the image and uploads it to Docker Hub. Watchtower looks out for image changes every 30 seconds. If the image is updated, Watchtower stops the current CodeyBot container, pulls the latest image, rebuilds the container and starts it up again.

	Due to the use of Watchtower, the <code>docker-compose.yml</code> to build the CodeyBot container cannot be automatically synced (without making things unnecessarily messy). In the past, we used GitHub SSH Action to sync everything (Docker image, <code>docker-compose.yml</code>, <code>.env</code>. However, at some point, the SSH broke, and we never figured out why. And the SSH-related creds are stored as GitHub secrets, and I have zero idea which one means what. So I just went with Watchtower (it's a lot more reliable anyways, just need to manually update 1 file).		Due to the use of Watchtower, the <code>docker-compose.yml</code> to build the CodeyBot container cannot be automatically synced (without making things unnecessarily messy). In the past, we used GitHub SSH Action to sync everything (Docker image, <code>docker-compose.yml</code>, <code>.env</code> and rebuilding container). However, at some point, the SSH broke, and we never figured out why. And the SSH-related creds are stored as GitHub secrets, and I have zero idea which one means what. So I just went with Watchtower (it's a lot more reliable anyways, just need to manually update 1 file).

Vdnguyen: /* Host */

2025-07-18T00:37:22Z

Host

← Older revision		Revision as of 19:37, 17 July 2025
Line 10:		Line 10:
	Now here comes the fun part. It's fun because there has never been a single documentation on this stuff. But I didn't enjoy that kind of fun. So please read this.		Now here comes the fun part. It's fun because there has never been a single documentation on this stuff. But I didn't enjoy that kind of fun. So please read this.

	=== ~~Host~~ ===		=== Hosting ===
	We have 3 servers to host CodeyBot for different purposes. All 3 servers are CSC Cloud VMs. Ask the current Termcom Lead/Sysadmin for access to the VMs. These 3 servers are:		We have 3 servers to host CodeyBot for different purposes. All 3 servers are CSC Cloud VMs. Ask the current Termcom Lead/Sysadmin for access to the VMs. These 3 servers are:
	* <code>codey-staging</code>: for staging, i.e. verifying that the <code>main</code> branch is behaving properly before shipping to production.		* <code>codey-staging</code>: for staging, i.e. verifying that the <code>main</code> branch is behaving properly before shipping to production.

Vdnguyen: /* Historical Note */

2025-07-18T00:36:58Z

Historical Note

← Older revision		Revision as of 19:36, 17 July 2025
Line 2:		Line 2:

	== Historical Note ==		== Historical Note ==
	We used to have a team dedicated to developing CodeyBot within the Organizing Committee, called CodeyBot Developer team. However, as of Fall 2025, in order to make the CSC Committee more efficient and organized ~~(funny i know)~~, CodeyBot Developer has been dissolved. The responsibilities of maintaining and developing CodeyBot now falls in the hands of Termcom.		We used to have a team dedicated to developing CodeyBot within the Organizing Committee, called CodeyBot Developer team. However, as of Fall 2025, in order to make the CSC Committee more efficient and organized, CodeyBot Developer has been dissolved. The responsibilities of maintaining and developing CodeyBot now falls in the hands of Termcom.

	== Contribution ==		== Contribution ==