update doku

This commit is contained in:
Marko Schrempf 2025-01-09 12:31:51 +01:00
parent e5b7874031
commit 98785355d3
8 changed files with 14 additions and 8 deletions

View File

@ -8,21 +8,26 @@ The workflow `Build and send diploma thesis` allows the user to build the diplom
### Microsoft Teams ### 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 ### GitHub
#### Settings #### 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. 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 | | 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: Now it should look like this:
![Github Headbar](github-action-secret-overview.png) ![Github action secret overview](img/github-action-secret-overview.png)
#### Repo #### 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 ### 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)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 152 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB