Run chromatic on branch ready #199

etienneburdet · 2023-10-11T15:03:01Z

Summary

The goal for this PR is to run chromatic only when the branch is ready is for review. The idea is that we would keep branches in draft state for longer and only turn them ready relatively late. It's always possible to discuss drafts or trigger manual runs.

For now:

API client code coverage run for each commit where api-client files has been edited
Viz CI run for each commit in a PR. Chromatic job run only when test and lint jobs passed with the PR state as 'ready for review'

Other possibilities include : run on label change, run on review request… for exemple.

Review workflow:

Create a new branch from this branch
Add commits that should break the CI (test or lint)
Open a PR in draft (CI should fail and chromatic job not run)
Fix the CI, chromatic job should still not run
Make the PR ready for review. CI should re-run with now chromatic running
Make a commit that break lint or test. CI should fail, chromatic job should not run

github-actions · 2023-10-12T06:55:56Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:05:24Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:14:21Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:15:36Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:20:28Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:23:54Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:31:07Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:37:50Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:38:02Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:38:41Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T07:56:10Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T08:12:35Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T08:12:36Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T08:22:28Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-12T09:58:33Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

github-actions · 2023-10-13T15:10:35Z

Total Coverage: 95.18%

Coverage Report

File	Branches	Funcs	Lines	Uncovered Lines
src
index.ts	100%	100%	100%
src/client
error.ts	100%	100%	100%
index.ts	73.97%	100%	96.83%	117, 139, 14, 141, 141, 142, 144, 155, 16, 16, 162, 162, 164, 169, 172, 175, 177, 18, 18, 51, 76
types.ts	100%	100%	100%
src/odsql
clauses.ts	71.43%	80%	90.91%	14, 32, 42
index.ts	83.72%	95.65%	94.12%	111, 140, 25, 28, 56, 57, 57, 57, 58, 68, 78, 79

etienneburdet · 2023-12-29T10:48:56Z

Ok this PR is officially "ready for review" (I had to turn it on and off to test stuff). The conditional trigger of Chromatic on lint seems to work well.

I didn't manage to have the if working properly on this branch, for not running on draft. It seems it only works if the PR opened as draft, but if it has been turned on/off it still runs everything 🤷

KevinFabre-ods

Thanks for taking care of that

Chromatic deployment:

is blocked when at least one test or lint job fails ✅
is run only when the PR is review for review 🚫

Don't know why but the if: github.event.pull_request.draft == false condition doesn't block the job

.github/workflows/visualizations.yml

KevinFabre-ods · 2024-01-10T14:24:56Z

In the viz workflow, replacing the

on: 
 - push

by

on: 
   pull_request:
      types:
        - opened
        - synchronize
        - reopened
        - ready_for_review

it works (#214)

to access github.event.pull_request.draft we need to react to the pull_request event, that what we are doing by adding the on: pull_request

etienneburdet · 2024-01-10T14:58:14Z

Ha nice, I think I lacked the synchronize in the early version for it to react to push. I'll just rebase to erase test commits before merging.

KevinFabre-ods · 2024-01-10T16:53:37Z

I already rebased and erased tests commits => 73a3814

KevinFabre-ods

Looks good to me now

@wmai you have review instructions in the PR description 😉

wmai

I've tried all sorts of choreographies, the CI behaves as expected, very good job, thank you for this work. 🙏

etienneburdet marked this pull request as ready for review October 12, 2023 06:21

etienneburdet marked this pull request as draft October 12, 2023 06:21

etienneburdet marked this pull request as ready for review October 12, 2023 06:58

etienneburdet marked this pull request as draft October 12, 2023 09:47

etienneburdet marked this pull request as ready for review October 12, 2023 09:47

etienneburdet marked this pull request as draft October 12, 2023 09:58

etienneburdet marked this pull request as ready for review October 13, 2023 15:38

etienneburdet marked this pull request as draft October 19, 2023 13:53

etienneburdet marked this pull request as ready for review December 29, 2023 10:00

etienneburdet marked this pull request as draft December 29, 2023 10:01

etienneburdet marked this pull request as ready for review December 29, 2023 10:43

etienneburdet force-pushed the chore/chromatic-on-ready branch from 4630e9c to 4ed15b7 Compare December 29, 2023 10:47

etienneburdet requested a review from KevinFabre-ods January 10, 2024 09:44

etienneburdet and others added 16 commits January 10, 2024 13:59

lint, should run chromatic now

3d7f118

lint correctly

1c80562

simpler condition

b20ebb4

without conditions

1ea4d9f

fix

d8196ce

and push a change to viz

d067c13

run chromatic maybe?

b5465a9

now with path

b210552

and change to viz

a7be874

conditions without path

525b3f2

ignore path without condition

a745071

restructure files

d81ec07

api client on push

943194e

fix: job name

e45eb45

chore: naming

77811c9

chore: remove test commit changes

73a3814

KevinFabre-ods force-pushed the chore/chromatic-on-ready branch from 0c78984 to 73a3814 Compare January 10, 2024 13:03

add working directory for new step

937580f

KevinFabre-ods mentioned this pull request Jan 10, 2024

Review of #199 #214

Closed

KevinFabre-ods requested changes Jan 10, 2024

View reviewed changes

.github/workflows/visualizations.yml Show resolved Hide resolved

KevinFabre-ods added 2 commits January 10, 2024 17:55

update viz CI workflows

f44e3fd

update lcov-reporter version

59f1754

KevinFabre-ods force-pushed the chore/chromatic-on-ready branch from a6c3654 to 59f1754 Compare January 10, 2024 17:08

KevinFabre-ods approved these changes Jan 10, 2024

View reviewed changes

wmai approved these changes Jan 11, 2024

View reviewed changes

KevinFabre-ods merged commit 681898d into main Jan 11, 2024
10 of 11 checks passed

KevinFabre-ods deleted the chore/chromatic-on-ready branch January 11, 2024 08:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Run chromatic on branch ready #199

Run chromatic on branch ready #199

etienneburdet commented Oct 11, 2023 •

edited by KevinFabre-ods

Loading

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 13, 2023

etienneburdet commented Dec 29, 2023

KevinFabre-ods left a comment •

edited

Loading

KevinFabre-ods commented Jan 10, 2024 •

edited

Loading

etienneburdet commented Jan 10, 2024

KevinFabre-ods commented Jan 10, 2024

KevinFabre-ods left a comment

wmai left a comment

Run chromatic on branch ready #199

Run chromatic on branch ready #199

Conversation

etienneburdet commented Oct 11, 2023 • edited by KevinFabre-ods Loading

Summary

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 12, 2023

github-actions bot commented Oct 13, 2023

etienneburdet commented Dec 29, 2023

KevinFabre-ods left a comment • edited Loading

Choose a reason for hiding this comment

KevinFabre-ods commented Jan 10, 2024 • edited Loading

etienneburdet commented Jan 10, 2024

KevinFabre-ods commented Jan 10, 2024

KevinFabre-ods left a comment

Choose a reason for hiding this comment

wmai left a comment

Choose a reason for hiding this comment

etienneburdet commented Oct 11, 2023 •

edited by KevinFabre-ods

Loading

KevinFabre-ods left a comment •

edited

Loading

KevinFabre-ods commented Jan 10, 2024 •

edited

Loading