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

ci: better readability, parallel execution (build & test) #4236

Merged
merged 19 commits into from
Jun 19, 2024

Conversation

BenedictHomuth
Copy link
Collaborator

@BenedictHomuth BenedictHomuth commented Jun 18, 2024

🚧 A repo admin must update our required checks 🚧

Since I split the Build and Test step from continuous-integration.yml into a frontend and backend part, the pipeline now runs in parallel.

But as far as I can tell we enforce that before merging, the specific step of our old Build and Test must be executed. Therefore the Build and Test check is pending and never gets executed anymore – resulting in 8 successful checks and 1 pending.

I found a similar issue in this GitHub discussion.
From my perspective, we need to update the checks_required in the repo settings, to accommodate the two new Build and Test steps and furthermore remove the old one.

Since I do not have repo permissions high enough, I can not do it myself.

Description

This PR contains a list of improvements for our CI:

  • The pipeline should now work again on main, therefore I conditionally check the base URL and set it to "main" instead of PR number – depending on where it runs.
  • The step Build & Test from our continuous-integration.yml is split in two (one for the frontend as well as one for the backend), therefore now executing in parallel.
  • Added caching to our new Build & Test – Backend step, therefore eliminating the need for redownloading all dependencies of go, even if nothing has changed
  • Merged the Go-Lint step into the Build & Test – Backend step
  • All URLs (Healthcheck and Postman) are now set via the continuous-integration.yml for more clarity
  • Updated the error message of the healthcheck action in case of failure (now additionally shows the HTTP status code e.g. 404)
  • Turned the before postman_tests.yml workflow into an action under .github/actions/postman_run. This way it is now possible to set the URL from the outside

Changelog

  • Split Build & Test
  • Added caching and linting to the new Build & Test – Backend step
  • Converted the postman workflow to an action
  • Made URLs settable only from continuous-integration.yml
  • Added additional logging for healthcheck

Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • The light- and dark-theme are both supported and tested
  • The design was implemented and is responsive for all devices and screen sizes
  • The application was tested in the most commonly used browsers (e.g. Chrome, Firefox, Safari)

(Optional) Visual Changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

@BenedictHomuth BenedictHomuth self-assigned this Jun 19, 2024
@BenedictHomuth BenedictHomuth added the Review Needed This pull request is ready for review label Jun 19, 2024

This comment has been minimized.

This comment has been minimized.

@Lennart01 Lennart01 self-requested a review June 19, 2024 13:54
Copy link

The deployment to the dev cluster was successful. You can find the deployment here: https://4236.development.scrumlr.fra.ics.inovex.io
This deployment is only for testing purposes and will be deleted after 1 week.
To redeploy rerun the workflow.
DO NOT STORE IMPORTANT DATA ON THIS DEPLOYMENT

Deployed Images
  • ghcr.io/inovex/scrumlr.io/scrumlr-frontend:sha-2cd1e7b

  • ghcr.io/inovex/scrumlr.io/scrumlr-server:sha-2cd1e7b

Copy link

octomind-dev bot commented Jun 19, 2024

🐙 Octomind

Test Report: 13/14 successful.

description status details
About Section Visibility Test Passed ✅ click
change avatar Passed ✅ click
check Privacy Policy Passed ✅ click
check terms & conditions Passed ✅ click
close cookie banner - front page Passed ✅ click
close cookie banner - sign-in Passed ✅ click
create and delete board columns Passed ✅ click
create_and_delete_notes_and_actions_v2 Failed ❌ click
create lean coffee board Passed ✅ click
edit_notes_and_actions_v5 Passed ✅ click
get started Passed ✅ click
share_session Passed ✅ click
sign-in Passed ✅ click
test all ways to open the setup flow Passed ✅ click

commit sha: 2cd1e7b

@Lennart01 Lennart01 added this pull request to the merge queue Jun 19, 2024
Merged via the queue into main with commit 60ff896 Jun 19, 2024
10 checks passed
@Lennart01 Lennart01 deleted the bh/ci-improvements branch June 19, 2024 14:17
BenedictHomuth added a commit that referenced this pull request Jun 27, 2024
Co-authored-by: Benedict Homuth <bhomuth@inovex.de>
Co-authored-by: Lennart Krauch <lennart.krauch@inovex.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Review Needed This pull request is ready for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants