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

Misleading CLI error regarding track.yml #11

Open
nol166 opened this issue Mar 29, 2024 · 0 comments
Open

Misleading CLI error regarding track.yml #11

nol166 opened this issue Mar 29, 2024 · 0 comments

Comments

@nol166
Copy link

nol166 commented Mar 29, 2024

Issue

On a few occasions, I and some members of my team have encountered an issue when attempting to push to instruqt. The CLI reports an error with the track.yml file, but the actual error seems to be with the assignment.md file in the teaser or contents properties.

Track info

slug: multi-analyzer
org: mongodb-dev

Error

2024-03-29T14:49:17.1526677Z ==> Reading track definition
2024-03-29T14:49:17.7525015Z     �[1;31m[ERROR]�[0m yaml: line 11: could not find expected ':'
2024-03-29T14:49:17.7526341Z     
2024-03-29T14:49:17.7551897Z ##[error]Process completed with exit code 1.

Actual issue:

In assignment.md, the issue actually seems to an improperly formatted teaser or contents property in the front-matter. If the indenting is off, it exits with an error

Screenshot 2024-03-29 at 11 42 06 AM

Suggested change

It seems like a more accurate error message in the CLI could mitigate some issues for users. There have been instances in the slack channel of this very issue impacting other teams as well. An error message that is specific to the file that is causing the problem would be better.

examples:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant