Adds workflow:validate command #2650

jonsamp · 2024-10-24T05:28:54Z

Why

This adds a command to validate YAML in workflow configuration files.

Screenshots

Valid YAML output

Invalid YAML output

Test Plan

Create a .yml file and test it with eas workflow:validate path/to/file.yml. You should see output like the screenshots above.

Make sure non existent files result in an error
Make sure non .yml/.yaml files result in an error
Make sure bad YAML results in an error
Make sure good YAML results in no error

linear · 2024-10-24T05:28:57Z

ENG-13772 Create workflows EAS CLI command

github-actions · 2024-10-24T05:43:21Z

Size Change: +156 kB (+0.3%)

Total Size: 52.9 MB

Filename	Size	Change
`./packages/eas-cli/dist/eas-linux-x64.tar.gz`	52.9 MB	+156 kB (+0.3%)

_{compressed-size-action}

codecov · 2024-10-24T05:44:14Z

Codecov Report

Attention: Patch coverage is 88.67925% with 6 lines in your changes missing coverage. Please review.

Project coverage is 52.95%. Comparing base (7c9970d) to head (645eb35).
Report is 12 commits behind head on main.

Files with missing lines	Patch %	Lines
packages/eas-cli/src/commands/workflow/validate.ts	88.68%	6 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2650      +/-   ##
==========================================
+ Coverage   52.92%   52.95%   +0.04%     
==========================================
  Files         570      572       +2     
  Lines       21834    21951     +117     
  Branches     4297     4329      +32     
==========================================
+ Hits        11554    11623      +69     
- Misses      10246    10294      +48     
  Partials       34       34

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

github-actions · 2024-11-04T23:22:45Z

Subscribed to pull request

File Patterns	Mentions
*/	@szdziedzic, @khamilowicz, @sjchmiela

Generated by CodeMention

sjchmiela

package manager discrepancy to fix
YAML parser discrepancy to comment on or fix
spinner to reconsider?

packages/eas-cli/package.json

packages/eas-cli/src/commands/workflow/validate.ts

sjchmiela · 2024-11-05T08:39:04Z

packages/eas-cli/src/commands/workflow/validate.ts

+
+  try {
+    const fileContents = await fs.readFile(filePath, 'utf8');
+    const parsedYaml = yaml.load(fileContents);


It would be much better if the command could also validate the schema, currently only in www. I think this is a sensible reason to move the workflow schema to eas-build-job later…

Another viable approach would be to use createWorkflowRun with some dry = true flag, or something. It would not create a workflow run or a workflow revision, only parse and validate with www.

Yeah, I guess that schema validation would have the biggest benefit for a user here, it would catch all of the typos and so on. Let's move the schema definition to eas-build-job and validate against it here.

I'm not sure how to move this to eas-build-job (not familiar with where that code is or what change to make there). Could we either pair or could one of you help me?

Also, ideally we'd write a JSON schema that we can validate against, and not only check that the YAML is valid. Adding that where the workflow runs would be great, then exporting it to here would be nice, to validate on the server and on the client, and have the same set of rules.

I'm not sure how to move this to eas-build-job (not familiar with where that code is or what change to make there). Could we either pair or could one of you help me?

Don't worry about it @jonsamp, this doesn't need to be a part of this PR and we can do it because we are familiar why how things work there 🙌

Also, ideally we'd write a JSON schema that we can validate against, and not only check that the YAML is valid. Adding that where the workflow runs would be great, then exporting it here would be nice, to validate on the server and on the client, and have the same set of rules.

I believe this is what @sjchmiela meant, we have this JSON schema validation implemented using Zod ready and working on both worker-level and WWW-level. We need to move it to eas-build-job which is a common lib for such definitions, that is shared between here, WWW, and other places 👍

I'm not sure how to move this to eas-build-job (not familiar with where that code is or what change to make there). Could we either pair or could one of you help me?

Will do. In the meantime, I think this is good to go. It's not a blocker.

ideally we'd write a JSON schema that we can validate against

I agree. I started looking into it a while back, but it wasn't too easy. Let me explain.

Exporting JSON schema from Zod schema (or writing it) for the "general" structure of the workflow YAML is easy. Validation of the actual jobs is where it becomes kinda difficult, because we either:

export Zod directly — then interpolations will be "error", because platform: android | ios does not expect platform: ${{ needs.setup.outputs.platform }}. "${{ needs.setup.outputs.platform }}" is not "android" or "ios" after all.

do some post-processing on Zod types, replacing enums with strings or expanding enum properties to allow that enum or an arbitrary string.

I think I had a branch somewhere that exposed this from www…

All in all — not a blocker for this to go.

yarn.lock

packages/eas-cli/package.json

packages/eas-cli/src/commands/workflow/validate.ts

szdziedzic · 2024-11-05T12:40:02Z

packages/eas-cli/src/commands/workflow/validate.ts

+
+  try {
+    const fileContents = await fs.readFile(filePath, 'utf8');
+    const parsedYaml = yaml.load(fileContents);


Yeah, I guess that schema validation would have the biggest benefit for a user here, it would catch all of the typos and so on. Let's move the schema definition to eas-build-job and validate against it here.

github-actions · 2024-11-06T18:42:02Z

⏩ The changelog entry check has been skipped since the "no changelog" label is present.

szdziedzic

Awesome, thanks for applying suggested changes 🚀

jonsamp force-pushed the jon/eng-13772-create-workflows-eas-cli-command branch from dbbf05e to 1706240 Compare October 24, 2024 05:31

adds validate command

91fc501

jonsamp force-pushed the jon/eng-13772-create-workflows-eas-cli-command branch from 5633e1e to 91fc501 Compare November 4, 2024 23:19

jonsamp added the no changelog PR that doesn't require a changelog entry label Nov 4, 2024

jonsamp marked this pull request as ready for review November 4, 2024 23:22

jonsamp requested review from byCedric and sjchmiela November 4, 2024 23:22

sjchmiela approved these changes Nov 5, 2024

View reviewed changes

szdziedzic reviewed Nov 5, 2024

View reviewed changes

jonsamp added 2 commits November 6, 2024 10:56

use yaml

7a2e199

incorp feedback

645eb35

szdziedzic approved these changes Nov 6, 2024

View reviewed changes

jonsamp merged commit d47b80a into main Nov 7, 2024
10 checks passed

jonsamp deleted the jon/eng-13772-create-workflows-eas-cli-command branch November 7, 2024 14:53

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adds workflow:validate command #2650

Adds workflow:validate command #2650

jonsamp commented Oct 24, 2024

linear bot commented Oct 24, 2024

github-actions bot commented Oct 24, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading

github-actions bot commented Nov 4, 2024

sjchmiela left a comment

sjchmiela Nov 5, 2024

szdziedzic Nov 5, 2024

jonsamp Nov 6, 2024

jonsamp Nov 6, 2024

szdziedzic Nov 6, 2024

sjchmiela Nov 6, 2024

szdziedzic Nov 5, 2024

github-actions bot commented Nov 6, 2024

szdziedzic left a comment

Adds workflow:validate command #2650

Adds workflow:validate command #2650

Conversation

jonsamp commented Oct 24, 2024

Why

Screenshots

Valid YAML output

Invalid YAML output

Test Plan

linear bot commented Oct 24, 2024

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

codecov bot commented Oct 24, 2024 • edited Loading

Codecov Report

github-actions bot commented Nov 4, 2024

sjchmiela left a comment

Choose a reason for hiding this comment

sjchmiela Nov 5, 2024

Choose a reason for hiding this comment

szdziedzic Nov 5, 2024

Choose a reason for hiding this comment

jonsamp Nov 6, 2024

Choose a reason for hiding this comment

jonsamp Nov 6, 2024

Choose a reason for hiding this comment

szdziedzic Nov 6, 2024

Choose a reason for hiding this comment

sjchmiela Nov 6, 2024

Choose a reason for hiding this comment

szdziedzic Nov 5, 2024

Choose a reason for hiding this comment

github-actions bot commented Nov 6, 2024

szdziedzic left a comment

Choose a reason for hiding this comment

github-actions bot commented Oct 24, 2024 •

edited

Loading

codecov bot commented Oct 24, 2024 •

edited

Loading