htlle-da-vorlage/tools/github/README.md

# Github tools

## General

The workflow `Build and send diploma thesis` allows the user to build the diploma thesis via a github workflow and send it to a Microsoft Teams channel.

## Setup

### Microsoft Teams

// TODO

### GitHub

#### Settings

In your GitHub Repository you first need to create the secrets the action needs. For that, go to the `Settings` Tab of your Repository and there under the section `Security` go to `Secrets and variables` and there to the option of `Actions`

![Github Headbar](github-repo-settings.png)

Now click on the button `New repository secret` to create the GitHub action secrets.

![Github Headbar](github-action-secret-creation.png)

Here you enter the names of the secrets and their values corresponding to the following table. After inserting one new secret click `Add secret`.

| Name | Secret |
|-|-|
| MAIL | Your email address from which the diploma thesis should be sent from  |
| MAIL_PASSWORD | The password for MAIL |
| SMTP_PORT | The SMTP port corresponding to SMTP_SERVER |
| SMTP_SERVER | The SMTP Server for your email address |
| TEAMS_MAIL | The Teams channel email from the channel the diploma thesis should be sent to |

Now it should look like this:

![Github Headbar](github-action-secret-overview.png)

#### Repo

Now create a folder ```.github/workflows``` in the root of your repository and copy and paste the file ```diploma-thesis.yml``` into it. Push it and everything is set.

### Notes

- Sending the diploma thesis, and therefore automated emails, using a school email address is not supported. It is best to use an email address that does not correspond to your school email address.