Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: System testing on DO took too many resources #614

Merged
merged 1 commit into from
May 3, 2024

Conversation

hoh
Copy link
Member

@hoh hoh commented May 3, 2024

Problem: Running system testing on DigitalOcean for every push consumed a lot of resources and failed frequently.

We now start to have integration testing using pytest, which provides a better confidence that things actually work.

Solution: Only test on DO open Pull Requests and not every push. In the future, consider only running when merged on main.

Problem: Running system testing on DigitalOcean for every push consumed a lot of resources and failed frequently.

We now start to have integration testing using `pytest`, which provides a better confidence that things actually work.

Solution: Only test on DO open Pull Requests and not every push. In the future, consider only running when merged on `main`.
Copy link

github-actions bot commented May 3, 2024

The PR is focusing on updating a GitHub Actions workflow file. This change is small and simple, likely due to a change in the rules for the workflow, or updating the workflow to a new version. The diff shows that the workflow is being updated and not removed or renamed, which is a common practice in GitHub Actions. The workflow is still being run and tested, which is good.

The changes do not seem to affect the core functionality of the system, or the overall architecture of the codebase, so the risk of introducing bugs is low. The impact on the codebase and review process is also minimal.

diff --git a/.github/workflows/test-on-droplets-matrix.yml b/.github/workflows/test-on-droplets-matrix.yml
index c67c1688..84746938 100644
--- a/.github/workflows/test-on-droplets-matrix.yml
+++ b/.github/workflows/test-on-droplets-matrix.yml
@@ -1,107 +1,30 @@
-name: "Test on DigitalOcean Droplets"
-
+# These are end-to-end tests running on ephemeral DigitalOcean "Droplet" virtual machines
+# with the different operating systems that are supported.
+#
+# The main focus of these tests is to ensure that the packaging works on all supported platforms
+# and to ensure the compatibility of dependencies (system and vendored) across these platforms.
+name: "Testing on DigitalOcean Droplets"
+
+# Run automatically on main branches, Pull Request updates and allow manual execution using `workflow_dispatch`.
 on:
-  push
+  push:
+    branches:
+       - main
+  pull_request:
+    types:
+       - 

RED: 
The PR is updating the GitHub Actions workflow file, but it is significant in terms of the number of jobs and steps involved. This change is likely to be used for running more comprehensive tests, or for setting up a new CI/CD pipeline.

The diff shows that the workflow is being updated to include new jobs and steps, which could potentially affect the system's functionality. The risk of introducing bugs is moderate, but the impact on the codebase and review process is high. The PR will require a deep understanding of the project's architecture and its current CI/CD pipeline.

```diff
diff --git a/.github/workflows/test-on-droplets-matrix.yml b/.github/workflows/test-on-droplets-matrix.yml
index c67c1688..84746938 100644
--- a/.github/workflows/test-on-droplets-matrix.yml
+++ b/.github/workflows/test-on-droplets-matrix.yml
@@ -1,107 +1,30 @@
-name: "Test on DigitalOcean Droplets"
-
+# These are end-to-end tests running on ephemeral DigitalOcean "Droplet" virtual machines
+# with the different operating systems that are supported.
+#
+# The main focus of these tests is to ensure that the packaging works on all supported platforms
+# and to ensure the compatibility of dependencies (system and vendored) across these platforms.
+name: "Testing on DigitalOcean Droplets"
+
+# Run automatically on main branches, Pull Request updates and allow manual execution using `workflow_dispatch`.
 on:
-  push
+  push:
+    branches:
+       - main
+  pull_request:
+    types:
+       - 

BLACK: 
The PR is updating the GitHub Actions workflow file to a significant extent. The diff shows a large number of new jobs and steps, and the update is likely to affect the entire CI/CD pipeline.

The risk of introducing bugs is high, as the changes will require a deep understanding of the project's architecture and its current CI/CD pipeline. Only experienced developers should review this PR, as it involves a significant change to the project's CI/CD pipeline.

```diff
diff --git a/.github/workflows/test-on-droplets-matrix.yml b/.github/workflows/test-on-droplets-matrix.yml
index c67c1688..84746938 100644
--- a/.github/workflows/test-on-droplets-matrix.yml
+++ b/.github/workflows/test-on-droplets-matrix.yml
@@ -1,107 +1,30 @@
-name: "Test on DigitalOcean Droplets"
-
+# These are end-to-end tests running on ephemeral DigitalOcean "Droplet" virtual machines
+# with the different operating systems that are supported.
+#
+# The main focus of these tests is to ensure that the packaging works on all supported platforms
+# and to ensure the compatibility of dependencies (system and vendored) across these platforms.
+name: "Testing on DigitalOcean Droplets"
+
+# Run automatically on main branches, Pull Request updates and allow manual execution using `workflow_dispatch`.
 on:
-  push
+  push:
+    branches:
+       - main
+  pull_request:
+    types:
+       - 

Please note that the categorization is based on the provided information and may not be 100% accurate. It's always recommended to review the PR in a safe environment before deciding on the complexity level.

@github-actions github-actions bot added the BLUE This PR is simple and straightforward. label May 3, 2024
Copy link

codecov bot commented May 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 43.87%. Comparing base (8318c43) to head (0350344).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #614   +/-   ##
=======================================
  Coverage   43.87%   43.87%           
=======================================
  Files          55       55           
  Lines        4978     4978           
  Branches      587      587           
=======================================
  Hits         2184     2184           
  Misses       2677     2677           
  Partials      117      117           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@MHHukiewitz MHHukiewitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, simple restructuring

@MHHukiewitz MHHukiewitz merged commit c942e27 into main May 3, 2024
24 checks passed
@MHHukiewitz MHHukiewitz deleted the hoh-droplets-pr-only branch May 3, 2024 14:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
BLUE This PR is simple and straightforward.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants