Optimize GitHub CI to Skip Unnecessary Tests Based on File Changes #14585

lukaszcl · 2024-09-27T08:16:06Z

This PR optimizes the GitHub CI workflows by implementing the following changes:

Skip E2E tests on Markdown changes: E2E tests will not run when only Markdown files are modified.
Isolate unit and E2E tests:
- Unit tests will not run when only end-to-end test files are changed.
- E2E tests will not run when only unit test files are changed.

Tests conducted for this PR:

Unit tests only changes: Verified that a PR with unit test changes does not build the Chainlink image or run E2E tests.
- Tt 1629 test unittest change #14593
E2E tests only changes: Verified that a PR with E2E test changes runs only E2E tests and skips unit tests.
- Tt 1629 test e2e changes #14587
Documentation changes: Confirmed that a PR with documentation updates does not trigger any tests.
- Tt 1629 test readme changes #14590
Workflow updates: Ensured that a PR with workflow-related changes runs the affected workflow.
- Tt 1629 test workflow changes #14591

…adme-md-files-are-changes

github-actions · 2024-10-14T10:10:44Z

WF: CI Core#1267d73

No errors found in this run. 🎉

scheibinger

Nice improvement, could you rename inputs and output params to use dashes instead of underscores, like in the most of the reusable actions in CL?

.github/actions/filter-changes/action.yml

.github/workflows/build-publish-develop-pr.yml

…adme-md-files-are-changes

.github/workflows/ci-core.yml

…s-are-changes' and 'TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes' of https://github.com/smartcontractkit/chainlink into TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes

…adme-md-files-are-changes

cl-sonarqube-production · 2024-10-15T15:10:36Z

Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarQube

jmank88 · 2024-10-15T16:09:40Z

.github/workflows/ci-core.yml

+    needs: [filter]
+    if: ${{ !contains(join(github.event.pull_request.labels.*.name, ' '), 'skip-smoke-tests') && github.actor != 'dependabot[bot]' && needs.filter.outputs.not_ignored_changes == 'true' }}


This applies to all modules. It must not be skipped for integration-tests/ changes.

Will be fixed in 29eba8e0bcf625b17870e36793b80925416b9aeb

jmank88 · 2024-10-15T16:11:20Z

.github/workflows/ci-scripts.yml

  lint-scripts:
    # We don't directly merge dependabot PRs, so let's not waste the resources
-    if: ${{ (github.event_name == 'pull_request' ||  github.event_name == 'schedule') && github.actor != 'dependabot[bot]' }}
+    needs: changes
+    if: ${{ (github.event_name == 'pull_request' ||  github.event_name == 'schedule') && github.actor != 'dependabot[bot]' && needs.changes.outputs.not_ignored_changes == 'true' }}


This doesn't look right to me. We expect scheduled runs to execute regardless of changes.

jmank88 · 2024-10-15T16:14:08Z

.github/workflows/ci-core.yml

  golangci:
    # We don't directly merge dependabot PRs, so let's not waste the resources
-    if: ${{ (github.event_name == 'pull_request' ||  github.event_name == 'schedule') && github.actor != 'dependabot[bot]' }}
+    if: ${{ (github.event_name == 'pull_request' ||  github.event_name == 'schedule') && github.actor != 'dependabot[bot]' && needs.filter.outputs.not_ignored_changes == 'true' }}


Scheduled runs are against the state of the repo, and whether or not there are recent changes is not relevant. We expect to flag all outstanding linter debt.

lukaszcl requested review from a team as code owners September 27, 2024 08:16

lukaszcl marked this pull request as draft September 27, 2024 08:16

Do not run tests on markdown changes

a1b6d85

lukaszcl force-pushed the TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes branch from aa8c94a to a1b6d85 Compare September 27, 2024 08:35

lukaszcl added 3 commits September 27, 2024 10:51

fix

60c74d2

Update build-publish-develop-pr.yml to not build cl image on md changes

8181938

Update ci-core.yml to not run on docs changes

8bd9f8e

lukaszcl force-pushed the TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes branch from 22aac96 to 8bd9f8e Compare September 27, 2024 09:15

lukaszcl added 3 commits September 27, 2024 11:24

Fix

0e7c9eb

Do not run ci-core.yml on changes to e2e tests

74ca898

Do not publish chainlink image on test changes

2d53ba6

lukaszcl force-pushed the TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes branch 4 times, most recently from fd6ab24 to feb168b Compare September 27, 2024 09:53

Fix

b414fc5

lukaszcl force-pushed the TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes branch from feb168b to b414fc5 Compare September 27, 2024 09:55

Add comments

ba81089

lukaszcl force-pushed the TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes branch from 10dadb0 to ba81089 Compare September 27, 2024 09:58

lukaszcl added 3 commits September 27, 2024 12:03

Update integration-tests.yml

7de971f

Update operator-ui-ci.yml

4dd0a88

Update client-compatibility-tests.yml

226d143

lukaszcl force-pushed the TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes branch from 2676d33 to 226d143 Compare September 27, 2024 10:15

lukaszcl added 2 commits September 27, 2024 13:50

test

cbb0066

Fix

086d88c

lukaszcl force-pushed the TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes branch from 4b00468 to 086d88c Compare September 27, 2024 12:01

Add filter-changes GHA

2b74e11

lukaszcl force-pushed the TT-1629-Optimise-Github-CI-checks-when-readme-md-files-are-changes branch from 40ba1f4 to 2b74e11 Compare September 27, 2024 12:24

fix

67d32d4

Merge branch 'develop' into TT-1629-Optimise-Github-CI-checks-when-re…

7bfd0d5

…adme-md-files-are-changes

lukaszcl changed the title ~~Do not run tests on markdown changes~~ Optimize GitHub CI to Skip Unnecessary Tests Based on File Changes Sep 27, 2024

lukaszcl added 3 commits September 27, 2024 16:20

Fix

ba8e305

Rename filters

57cd104

Merge branch 'develop' into TT-1629-Optimise-Github-CI-checks-when-re…

b742bae

…adme-md-files-are-changes

lukaszcl requested review from kalverra, skudasov, chainchad and jmank88 October 2, 2024 14:49

Merge branch 'develop' into TT-1629-Optimise-Github-CI-checks-when-re…

41550d5

…adme-md-files-are-changes

lukaszcl marked this pull request as ready for review October 14, 2024 12:14

scheibinger requested changes Oct 15, 2024

View reviewed changes

.github/actions/filter-changes/action.yml Outdated Show resolved Hide resolved

rename inputs and output params to use dashes instead of underscores

f0c1959

lukaszcl requested a review from scheibinger October 15, 2024 10:26

scheibinger previously approved these changes Oct 15, 2024

View reviewed changes

jmank88 reviewed Oct 15, 2024

View reviewed changes

.github/workflows/build-publish-develop-pr.yml Show resolved Hide resolved

Merge branch 'develop' into TT-1629-Optimise-Github-CI-checks-when-re…

dbe8142

…adme-md-files-are-changes

jmank88 requested changes Oct 15, 2024

View reviewed changes

.github/workflows/ci-core.yml Outdated Show resolved Hide resolved

lukaszcl added 2 commits October 15, 2024 16:52

Keep running unit tests on markdown changes

f4b1f98

lukaszcl dismissed scheibinger’s stale review via b13db5e October 15, 2024 14:52

Merge branch 'develop' into TT-1629-Optimise-Github-CI-checks-when-re…

1267d73

…adme-md-files-are-changes

lukaszcl requested a review from jmank88 October 15, 2024 14:56

jmank88 reviewed Oct 15, 2024

View reviewed changes

jmank88 requested review from HenryNguyen5 and momentmaker October 15, 2024 16:16

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Optimize GitHub CI to Skip Unnecessary Tests Based on File Changes #14585

Optimize GitHub CI to Skip Unnecessary Tests Based on File Changes #14585

lukaszcl commented Sep 27, 2024 •

edited

Loading

github-actions bot commented Oct 14, 2024 •

edited

Loading

scheibinger left a comment

cl-sonarqube-production bot commented Oct 15, 2024

jmank88 Oct 15, 2024

lukaszcl Oct 16, 2024

jmank88 Oct 15, 2024

jmank88 Oct 15, 2024

		needs: [filter]
		if: ${{ !contains(join(github.event.pull_request.labels.*.name, ' '), 'skip-smoke-tests') && github.actor != 'dependabot[bot]' && needs.filter.outputs.not_ignored_changes == 'true' }}

Optimize GitHub CI to Skip Unnecessary Tests Based on File Changes #14585

Are you sure you want to change the base?

Optimize GitHub CI to Skip Unnecessary Tests Based on File Changes #14585

Conversation

lukaszcl commented Sep 27, 2024 • edited Loading

github-actions bot commented Oct 14, 2024 • edited Loading

WF: CI Core#1267d73

scheibinger left a comment

Choose a reason for hiding this comment

cl-sonarqube-production bot commented Oct 15, 2024

Quality Gate passed

jmank88 Oct 15, 2024

Choose a reason for hiding this comment

lukaszcl Oct 16, 2024

Choose a reason for hiding this comment

jmank88 Oct 15, 2024

Choose a reason for hiding this comment

jmank88 Oct 15, 2024

Choose a reason for hiding this comment

lukaszcl commented Sep 27, 2024 •

edited

Loading

github-actions bot commented Oct 14, 2024 •

edited

Loading