feat: update push and push-status commands #1481

lesyk-lesyk · 2024-03-14T09:38:06Z

What/Why/How?

This PR refactors push and push-status commands.
After this PR, these commands will return the necessary values for use in other places (like GH action).
Stylish output was not changed.

Reference

https://github.com/orgs/Redocly/projects/42?pane=issue&itemId=54045541

Testing

Unit tests, local.

Screenshots (optional)

Check yourself

Code changed? - Tested with redoc/reference-docs/workflows (internal)
All new/updated code is covered with tests
New package installed? - Tested in different environments (browser/node)

Security

Security impact of change has been considered
Code follows company security practices and guidelines

changeset-bot · 2024-03-14T09:38:10Z

🦋 Changeset detected

Latest commit: 73e846a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
@redocly/cli	Minor
@redocly/openapi-core	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2024-03-14T09:39:15Z

Command	Mean [ms]	Min [ms]	Max [ms]	Relative
`redocly lint packages/core/src/benchmark/benches/rebilly.yaml`	948.5 ± 20.2	925.9	979.0	1.00
`redocly-next lint packages/core/src/benchmark/benches/rebilly.yaml`	956.0 ± 19.3	938.9	996.0	1.01 ± 0.03

github-actions · 2024-03-14T09:39:56Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	77.05%	4451/5777
🟡	Branches	67.48%	2447/3626
🟡	Functions	70.73%	742/1049
🟡	Lines	77.24%	4185/5418

Show new covered files 🐣

St.^❔	File	Statements	Branches	Functions	Lines
🟢	`...` / utils.ts	100%	87.5%	100%	100%

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🟡	core/src/utils.ts	76.56% (-1.04% 🔻)	63.64%	73.91% (-3.36% 🔻)	77.12%
🟢	core/src/index.ts	100%	100%	7.27%	100%

Test suite run success

734 tests passing in 102 suites.

Report generated by 🧪jest coverage report action from 73e846a

.changeset/heavy-swans-sin.md

lornajane

Couple of suggestions, the docs are currently in a private repo but the pull request for the docs updates should be linked from this pull request.

lornajane · 2024-03-28T10:27:27Z

packages/cli/src/index.ts

@@ -179,6 +180,11 @@ yargs
            description: 'Maximum execution time in seconds.',
            type: 'number',
          },
+          'ignore-deployment-failures': {


I think this should be continue-on-error or something along those likes (github uses continue-on-error)

Maybe continue-on-deployment-error will be better?

We use the term deploy and not deployment universally. I'm a stickler for sticking to domain language so I think we shouldn't use the word deployment whenever we can avoid it. @lesyk-lesyk

Updated to continue-on-deploy-failures, thanks! @adamaltman

packages/cli/src/index.ts

lornajane · 2024-03-28T10:28:45Z

packages/cli/src/index.ts

@@ -340,6 +346,11 @@ yargs
            type: 'boolean',
            default: false,
          },
+          'ignore-deployment-failures': {


Suggest that we might rename this option as above

I have renamed this parameter to continue-on-deploy-failures

packages/cli/src/index.ts

lornajane · 2024-03-28T10:30:02Z

packages/cli/src/index.ts

@@ -179,6 +180,11 @@ yargs
            description: 'Maximum execution time in seconds.',
            type: 'number',
          },
+          'ignore-deployment-failures': {


Also it will need a docs update (in a different repo at the moment I know, it's fine to create the PR or a ticket on the monorepo and link to this PR for now)

I have created a separate task for docs. Thanks.

packages/cli/src/cms/commands/utils.ts

packages/cli/src/cms/commands/push-status.ts

tatomyr

Had a quick look. Will review in more details a bit later.

.changeset/heavy-swans-sin.md

packages/cli/src/cms/commands/__tests__/push-status.test.ts

packages/cli/src/cms/commands/push-status.ts

tatomyr

Left a few minor comments.

packages/cli/src/cms/commands/push-status.ts

packages/cli/src/cms/commands/push.ts

packages/cli/src/cms/commands/utils.ts

packages/cli/src/cms/api/types.ts

resources/museum.yaml

tatomyr

Looks good. Thank you!

…ommand

command

Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com> Co-authored-by: Roman Sainchuk <albuman32@gmail.com>

…failures'

…ploy-failures"

tatomyr changed the title ~~Feat/update push status command~~ feat: update push status command Mar 14, 2024

lesyk-lesyk changed the title ~~feat: update push status command~~ feat: update push and push-status commands Mar 27, 2024

lesyk-lesyk marked this pull request as ready for review March 27, 2024 12:19

lesyk-lesyk requested review from a team as code owners March 27, 2024 12:19

lornajane reviewed Mar 28, 2024

View reviewed changes

.changeset/heavy-swans-sin.md Outdated Show resolved Hide resolved

lornajane reviewed Mar 28, 2024

View reviewed changes

roman-sainchuk reviewed Mar 28, 2024

View reviewed changes

packages/cli/src/cms/commands/utils.ts Outdated Show resolved Hide resolved

packages/cli/src/cms/commands/utils.ts Show resolved Hide resolved

packages/cli/src/cms/commands/push-status.ts Show resolved Hide resolved

packages/cli/src/cms/commands/push-status.ts Outdated Show resolved Hide resolved

tatomyr reviewed Apr 2, 2024

View reviewed changes

.changeset/heavy-swans-sin.md Outdated Show resolved Hide resolved

packages/cli/src/cms/commands/__tests__/push-status.test.ts Outdated Show resolved Hide resolved

packages/cli/src/cms/commands/push-status.ts Show resolved Hide resolved

lesyk-lesyk force-pushed the feat/update-push-status-command branch 2 times, most recently from d9d4d34 to 0101846 Compare April 15, 2024 12:12

tatomyr reviewed Apr 16, 2024

View reviewed changes

packages/cli/src/cms/commands/push-status.ts Outdated Show resolved Hide resolved

packages/cli/src/cms/commands/push.ts Outdated Show resolved Hide resolved

packages/cli/src/cms/commands/utils.ts Outdated Show resolved Hide resolved

lesyk-lesyk force-pushed the feat/update-push-status-command branch 2 times, most recently from ac40017 to 9edd6b3 Compare April 23, 2024 14:40

roman-sainchuk reviewed Apr 23, 2024

View reviewed changes

packages/cli/src/cms/api/types.ts Outdated Show resolved Hide resolved

tatomyr assigned lesyk-lesyk Apr 23, 2024

tatomyr added the deploy_s3_sandbox label Apr 23, 2024

tatomyr reviewed Apr 23, 2024

View reviewed changes

resources/museum.yaml Outdated Show resolved Hide resolved

tatomyr approved these changes Apr 23, 2024

View reviewed changes

lesyk-lesyk requested a review from roman-sainchuk April 23, 2024 15:59

lesyk-lesyk added 7 commits April 24, 2024 08:21

feat(bh): make 'project' and 'domain' required for push command (CMS)

a51736f

chore: add OutputFormat type for 'format' parameter for push-status c…

cfb843f

…ommand

feat: add 'format' parameter for 'push-status'

c7c506a

command

feat: add 'markdown' to OutputFormat type

0d55260

feat: make domain not required for push-status

20a34ce

refactor: simplify handlePushStatus function

f91bc4a

feat: add json format for push-status command

2930fe9

lesyk-lesyk and others added 22 commits April 24, 2024 08:21

chore: replace "satisfies" with "as"

d197dbc

chore: add changeset

67ca2dc

feat: add onTimeOutExceeded callback

0d87192

Apply suggestions from code review

9aee289

Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>

Apply suggestions from code review

8c63b73

Co-authored-by: Andrew Tatomyr <andrew.tatomyr@redocly.com> Co-authored-by: Roman Sainchuk <albuman32@gmail.com>

chore: update return type for commandHandler

20cec52

tests: use expect.rejects instead of catching errors

7557e79

feat: rename 'ignore-deployment-failures' to 'continue-on-deployment-…

a2ccc0f

…failures'

feat: add onConditionNotMet callback

a73f32a

tests: add unit tests

e741344

chore: add comments

6b89c26

refactor: rename "wait" to "pause" and move to utils

821cfed

refactor: change import type

f04c1b1

refactor: add explicit array length check

988d717

fix: add correct wrapper type for argv params

a0d2f5f

feat: update types for push status API

5baf378

chore: add "unit:watch" script to package.json

539f71d

test: fix unit tests

d8ae15e

tests: add tests for "onRetry" and "max-execution-time" parameters

51ef6fb

chore: restore museum.yaml

fd42509

feat: update API types for PushResponse

cbc60ab

refactor: rename "continue-on-deployment-failures" to "continue-on-de…

1513c8e

…ploy-failures"

lesyk-lesyk force-pushed the feat/update-push-status-command branch from f7dd65c to 1513c8e Compare April 24, 2024 05:22

roman-sainchuk approved these changes Apr 24, 2024

View reviewed changes

lesyk-lesyk added 4 commits April 25, 2024 09:30

feat: update interface for onRetry function

e2b620e

feat: remove "instanceof Promise" check

323a697

refactor: reorder imports

20a2dba

feat: increase maxExecutionTime to 20 min

73e846a

lesyk-lesyk merged commit 4cf08db into main Apr 25, 2024
30 checks passed

lesyk-lesyk deleted the feat/update-push-status-command branch April 25, 2024 11:42

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: update push and push-status commands #1481

feat: update push and push-status commands #1481

lesyk-lesyk commented Mar 14, 2024 •

edited

Loading

changeset-bot bot commented Mar 14, 2024 •

edited

Loading

github-actions bot commented Mar 14, 2024 •

edited

Loading

github-actions bot commented Mar 14, 2024 •

edited

Loading

lornajane left a comment

lornajane Mar 28, 2024

lesyk-lesyk Mar 28, 2024

adamaltman Apr 23, 2024 •

edited

Loading

lesyk-lesyk Apr 24, 2024

lornajane Mar 28, 2024

lesyk-lesyk Apr 16, 2024 •

edited

Loading

lornajane Mar 28, 2024

lesyk-lesyk Apr 16, 2024 •

edited

Loading

tatomyr left a comment

tatomyr left a comment

tatomyr left a comment

feat: update push and push-status commands #1481

feat: update push and push-status commands #1481

Conversation

lesyk-lesyk commented Mar 14, 2024 • edited Loading

What/Why/How?

Reference

Testing

Screenshots (optional)

Check yourself

Security

changeset-bot bot commented Mar 14, 2024 • edited Loading

🦋 Changeset detected

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

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

Coverage report

Test suite run success

lornajane left a comment

Choose a reason for hiding this comment

lornajane Mar 28, 2024

Choose a reason for hiding this comment

lesyk-lesyk Mar 28, 2024

Choose a reason for hiding this comment

adamaltman Apr 23, 2024 • edited Loading

Choose a reason for hiding this comment

lesyk-lesyk Apr 24, 2024

Choose a reason for hiding this comment

lornajane Mar 28, 2024

Choose a reason for hiding this comment

lesyk-lesyk Apr 16, 2024 • edited Loading

Choose a reason for hiding this comment

lornajane Mar 28, 2024

Choose a reason for hiding this comment

lesyk-lesyk Apr 16, 2024 • edited Loading

Choose a reason for hiding this comment

tatomyr left a comment

Choose a reason for hiding this comment

tatomyr left a comment

Choose a reason for hiding this comment

tatomyr left a comment

Choose a reason for hiding this comment

lesyk-lesyk commented Mar 14, 2024 •

edited

Loading

changeset-bot bot commented Mar 14, 2024 •

edited

Loading

github-actions bot commented Mar 14, 2024 •

edited

Loading

github-actions bot commented Mar 14, 2024 •

edited

Loading

adamaltman Apr 23, 2024 •

edited

Loading

lesyk-lesyk Apr 16, 2024 •

edited

Loading

lesyk-lesyk Apr 16, 2024 •

edited

Loading