diff --git a/tools/github/README.md b/tools/github/README.md index 084dcaf..7c742e1 100644 --- a/tools/github/README.md +++ b/tools/github/README.md @@ -8,21 +8,26 @@ The workflow `Build and send diploma thesis` allows the user to build the diplom ### Microsoft Teams -// TODO +1. Create a new channel in your Team named `build`. +2. Go to the channel settings of `build` and go to `Get email address`. + +![Github Headbar](img/teams-channel-settings.png) + +3. Copy the email address which is inside of the sharp brackets. ### 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` +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 under the section `Security` go to `Secrets and variables` and choose to the option `Actions`. -![Github Headbar](github-repo-settings.png) +![Github repository settings](img/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) +![Github secret creation](img/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`. +Here you enter the names of the secrets and their values corresponding to the following table. After inserting the contents of the new secret click `Add secret`. | Name | Secret | |-|-| @@ -34,12 +39,13 @@ Here you enter the names of the secrets and their values corresponding to the fo Now it should look like this: -![Github Headbar](github-action-secret-overview.png) +![Github action secret overview](img/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. +Create a folder `.github/workflows` in the root of your repository. You can now choose between `diploma-thesis-docker.yml` and `diploma-thesis-manual.yml` to paste into the newly created folder. The difference between them is, that the **-docker** uses the Docker image (for new diploma theses) and the **-manual** installs all the dependencies in the action itself (for old diploma theses). ### 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. +- Sending the diploma thesis, and therefore automated emails, using a school email address is not supported. Therefore use an email address that does not correspond to your school email address. +- If you use Gmail as a sending email address, you have to generate an app password and use this instead of your normal password. [Manual](https://knowledge.workspace.google.com/kb/how-to-create-app-passwords-000009237) diff --git a/tools/github/github-action-secret-creation.png b/tools/github/github-action-secret-creation.png deleted file mode 100644 index 35f21da..0000000 Binary files a/tools/github/github-action-secret-creation.png and /dev/null differ diff --git a/tools/github/github-action-secret-overview.png b/tools/github/github-action-secret-overview.png deleted file mode 100644 index 842a366..0000000 Binary files a/tools/github/github-action-secret-overview.png and /dev/null differ diff --git a/tools/github/github-repo-settings.png b/tools/github/github-repo-settings.png deleted file mode 100644 index b85478d..0000000 Binary files a/tools/github/github-repo-settings.png and /dev/null differ diff --git a/tools/github/img/github-action-secret-creation.png b/tools/github/img/github-action-secret-creation.png new file mode 100644 index 0000000..dc7ce17 Binary files /dev/null and b/tools/github/img/github-action-secret-creation.png differ diff --git a/tools/github/img/github-action-secret-overview.png b/tools/github/img/github-action-secret-overview.png new file mode 100644 index 0000000..e8eadcf Binary files /dev/null and b/tools/github/img/github-action-secret-overview.png differ diff --git a/tools/github/img/github-repo-settings.png b/tools/github/img/github-repo-settings.png new file mode 100644 index 0000000..b3d919a Binary files /dev/null and b/tools/github/img/github-repo-settings.png differ diff --git a/tools/github/img/teams-channel-settings.png b/tools/github/img/teams-channel-settings.png new file mode 100644 index 0000000..ca948bf Binary files /dev/null and b/tools/github/img/teams-channel-settings.png differ