minnes-website

This repository:

• Stores HTML/CSS/images for Mia Minnes' professional homepage
• Automatically deploys to https://miaminnes.github.io/minnes-website/ and to https://cseweb.ucsd.edu/~minnes on commit and push to the repository

Editing

You can edit the HTML/CSS/images directly through the Github editing interfaces. When you commit/save, you will be able to see your changes reflected in https://miaminnes.github.io/minnes-website/ a few minutes later. It's also fine to clone and edit locally and push later, but for quick updates the web interface on Github is particularly convenient, especially if the goal is to just fix up some typos, etc.

The site is completely built in HTML and CSS, and there is no build system – it's just the files you see. As more pages get added it may be worth adding a build system to share a common header, etc. The Bootstrap CSS library is directly copied/hosted in the repository, which is the main exernal dependency for layout.

The Bootstrap elements that are used are: grid (rows and columns) and nav.

Deploying

The script in .github/workflows is responsible for copying the files to https://cseweb.ucsd.edu/~minnes when we trigger the action. It has a SSH key for [email protected] user stored as a repository secret, and uses scp to copy and overwrite all the files in the relevant target directory on that host.

Understanding .github/workflows/main.yml:

The environment variables are set so that files can be copied to the internshipsymposium.ucsd.edu server automatically (without entering the password each time). To set this up, a public/private rsa key pair is needed.

1. Locally (e.g. in Terminal), run ssh-keygen and (when prompted) enter full path for file to save key e.g. /Users/username/.ssh/id_rsa and do not enter a passphrase (so that action can run without user input)
2. Copy the public key to a line in the authorized_keys file in [email protected], e.g. using FTP with the command put /Users/username/.ssh/id_rsa.pub .ssh/authorized keys
3. Store the private key as an Actions secret: navigate to Settings --> Secrets --> Actions and select "New repository secret" and copy the contents of id_rsa to the secret. The name of this secret is stored in the Github Action environment variable SIS_SSH_KEY on line 25.
4. Locally (e.g. in Terminal), generate the key signatures of the login.eng.ucsd.edu host by running ssh-keyscan login.eng.ucsd.edu. The non-commented lines that are printed by this command are stored in the Github Action environment variable KNOWN_HOSTS on lines 27-29.
5. The Github Action runs by copying the private key to a file in the repo (line 31), copying the signatures of the host (line 33), setting permissions to use the private key (line 33), and then using scp to copy all the files for the website using the private key to authenticate (line 34).

To deploy, use the Actions interface, selecting Deploy to loging.eng.ucsd.edu and clicking the button Run workflow, Use workflow from Branch: main, Run workflow.