Skip to content

Commit ae05b67

Browse files
committed
Update automation lecture for wt2425
1 parent f162521 commit ae05b67

File tree

6 files changed

+25
-21
lines changed

6 files changed

+25
-21
lines changed

05_testing_and_ci/automation_exercise.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
In this exercise, we create automated workflows and pipelines based on GitHub Actions. We are again working with our beloved diffusion Python code.
44

5-
Deadline: **Thursday, February 2nd, 2023, 09:00**
5+
Deadline: **Thursday, January 29th, 2025, 09:00**
66

77
## Preparations
88

9-
Import the [automation exercise repository](https://github.com/Simulation-Software-Engineering/automation-exercise-wt2223) in your own account/namespace on GitHub and name it `automation-exercise` again. **Note**: We cannot work with forks here because GitHub Actions may not work in pull requests without explicit approval of the owner of the target repository
9+
Import the [automation exercise repository](https://github.com/Simulation-Software-Engineering/automation-exercise-wt2425) in your own account/namespace on GitHub and name it `automation-exercise`. It is also easier to add badges (see below) to the `README.md` if the repository is under your control.
10+
11+
**Note**: We cannot work with forks here because GitHub Actions may not work in pull requests without explicit approval of the owner of the target repository
1012

1113
## Task descriptions
1214

@@ -24,12 +26,12 @@ Once the workflow runs successfully, add a [GitHub workflow status badge](https:
2426

2527
## Submission
2628

27-
- Submit your solution via an issue in the *upstream* [automation exercise repository](https://github.com/Simulation-Software-Engineering/automation-exercise-wt2223). The issue should be named `[USERNAME] Automation exercise`, e.g., `[uekermbn] Automation exercise`. Please use your GitLab username here. Add a link to your GitHub repository in the issue. If necessary, add further explanations in the issue description.
29+
- Submit your solution via an issue in the *upstream* [automation exercise repository](https://github.com/Simulation-Software-Engineering/automation-exercise-wt2425). The issue should be named `[USERNAME] Automation exercise`, e.g., `[uekermbn] Automation exercise`. Please use your GitLab username here. Add a link to your GitHub repository in the issue. If necessary, add further explanations in the issue description.
2830

2931
## Bonus: GitLab CI/CD
3032

3133
Realize the same workflows in GitLab CI/CD :)
3234

3335
- Create a new project under your namespace and push your existing automation repository to this remote.
3436
- Create a VM on [bwCloud](https://www.bw-cloud.org/) and create a GitLab Runner with a Docker executor there. Register the runner in your repository.
35-
- Add a link to this repository in the submission issue above and, if necessary, explain what you did. Be sure that your repository is visible to us (either public or add `uekermbn`).
37+
- Add a link to this repository in the submission issue above and, if necessary, explain what you did. Be sure that your repository is visible to us (either public or add `gchourdakis`).

05_testing_and_ci/automation_slides.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,10 @@ slideOptions:
6464

6565
- Check code formatting and quality
6666
- Compile and test code for different platforms
67-
- Generate coverage reports and visualization
67+
- Periodically run tasks
68+
- Big tests, nightly builds...
6869
- Build documentation and deploy it
70+
- Generate coverage reports and visualization
6971
- Build, package, and upload releases
7072

7173
---

05_testing_and_ci/github_actions_demo.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## 1. Setting up a Test Job
44

5-
- Clone [automation lecture repository](https://github.com/Simulation-Software-Engineering/automation-lecture-wt2223) and run code and tests
5+
- Clone [automation lecture repository](https://github.com/Simulation-Software-Engineering/automation-lecture-wt2425) and run code and tests
66
- Set up workflow file
77

88
```bash
@@ -107,12 +107,12 @@
107107
## 3. Other Workflows
108108

109109
- Show workflows of [preCICE](https://github.com/precice/precice)
110-
- Show `Actions` tab
111-
- `Build and test` job, click on a run
112-
- Jobs created through test matrix
113-
- Click on a job, click on a few steps
114-
- Show `workflows` folder, click on `Build and Test`
115-
- Only one job. `build`, `test`, ... are modeled as steps
110+
- Show `Actions` tab
111+
- `Build and test` job, click on a run
112+
- Jobs created through test matrix
113+
- Click on a job, click on a few steps
114+
- Show `workflows` folder, click on `Build and Test`
115+
- Only one job. `build`, `test`, ... are modeled as steps
116116

117117
## 4. act Demo
118118

05_testing_and_ci/github_actions_slides.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ From: [https://docs.github.com/en/actions](https://docs.github.com/en/actions)
6969

7070
## Components (2/2)
7171

72-
<img src="https://docs.github.com/assets/cb-25628/images/help/images/overview-actions-simple.png" width=95%; style="margin-left:auto; margin-right:auto; padding-top: 25px; padding-bottom: 25px; background: #eeeeee">
72+
<img src="https://docs.github.com/assets/cb-25535/mw-1440/images/help/actions/overview-actions-simple.webp" width=95%; style="margin-left:auto; margin-right:auto; padding-top: 25px; padding-bottom: 25px; background: #eeeeee">
7373

7474

7575
From [GitHub Actions tutorial](https://docs.github.com/en/actions)
@@ -78,7 +78,7 @@ From [GitHub Actions tutorial](https://docs.github.com/en/actions)
7878

7979
## Setting up a Workflow
8080

81-
- Workflow file files stored `${REPO_ROOT}/.github/workflows`
81+
- Workflow files stored in `${REPO_ROOT}/.github/workflows`
8282
- Configured via YAML file
8383

8484
```yaml
@@ -198,7 +198,7 @@ steps:
198198

199199
```yaml
200200
- name: "Upload artifact"
201-
uses: actions/upload-artifact@v2
201+
uses: actions/upload-artifact@v4
202202
with:
203203
name: my-artifact
204204
path: my_file.txt
@@ -238,13 +238,14 @@ steps:
238238
## Demo: GitHub Actions
239239

240240
- Set up simple CI pipeline using GitHub Actions
241-
- Reuse code of Python testing lecture
242241
- Pipeline has three steps
243242

244243
1. Check formatting
245244
2. Build application
246245
3. Test application
247246

247+
- Reusing code of Python testing lecture
248+
248249
---
249250

250251
## Advanced Topics

05_testing_and_ci/gitlab_ci_demo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Demo: GitLab Runner
22

3-
Test code in [automation lecture repository](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2223/lecture-automation) on our GitLab instance
3+
Test code in [automation lecture repository](https://gitlab-sim.informatik.uni-stuttgart.de/simulation-software-engineering-wite2425/lecture-automation) on our GitLab instance
44

55
## Inspect Repository
66

05_testing_and_ci/gitlab_ci_slides.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ From: [https://docs.gitlab.com/ee/ci/](https://docs.gitlab.com/ee/ci/)
5656
- Jobs in one stage my be executed in parallel
5757
- Stages: Group jobs and determine running order
5858
- [Runner](https://docs.gitlab.com/runner/): Server that runs jobs
59-
- [Artifacts](https://docs.gitlab.com/ee/ci/pipelines/job_artifacts.html): Files to be shared between jobs or to be kept after workflow finishes
59+
- [Artifacts](https://docs.gitlab.com/ee/ci/jobs/job_artifacts.html): Files to be shared between jobs or to be kept after workflow finishes
6060
- No "Actions", but instead integrated features
6161
- Repository checked out by default
6262
- Handling of artifacts integrated
@@ -191,11 +191,10 @@ deploy job:
191191
192192
- Complex pipelines, e.g.,
193193
- [Directed Acyclic Graph](https://docs.gitlab.com/ee/ci/directed_acyclic_graph/)
194-
- [Multi-project pipelines](https://docs.gitlab.com/ee/ci/pipelines/multi_project_pipelines.html)
195-
- [Parent-child pipelines](https://docs.gitlab.com/ee/ci/pipelines/parent_child_pipelines.html)
194+
- [Multi-project pipelines](https://docs.gitlab.com/ee/ci/pipelines/downstream_pipelines.html#multi-project-pipelines)
196195
- [Anchors](https://docs.gitlab.com/ee/ci/yaml/yaml_optimization.html#anchors)
197196
- [ChatOps](https://docs.gitlab.com/ee/ci/chatops/)
198-
- [Extended testing](https://docs.gitlab.com/ee/ci/unit_test_reports.html)
197+
- [Extended testing](https://docs.gitlab.com/ee/ci/testing/unit_test_reports.html)
199198
200199
---
201200

0 commit comments

Comments
 (0)