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

[Bug] Step "Run markdown lint" ends with en error #44

Open
ricardojfc opened this issue Oct 2, 2023 · 6 comments
Open

[Bug] Step "Run markdown lint" ends with en error #44

ricardojfc opened this issue Oct 2, 2023 · 6 comments
Labels
bug Something isn't working needs engineering Requires engineering-specific changes only.

Comments

@ricardojfc
Copy link

ricardojfc commented Oct 2, 2023

Summary

Step "Run markdown lint" ends with en error and the README.md isn't updated

How to reproduce

  1. Open a new browser tab, and work on the steps in your second tab while you read the instructions in this tab

  2. Go to the Actions tab.

  3. Click New workflow.

  4. Search for "Simple workflow" and click Configure.

  5. Name your workflow ci.yml.

  6. Update the workflow to remove all steps other than the "checkout" step.

  7. Add the following step to your workflow:

    - name: Run markdown lint
      run: |
        npm install remark-cli remark-preset-lint-consistent
        npx remark . --use remark-preset-lint-consistent --frail

    Even after the code is indented properly in ci.yml, you will see a build error in GitHub Actions. We'll fix this in the next step.

  8. Click Start commit, and choose to make a new branch named ci.

  9. Click Propose a new file.

  10. Click Create pull request.

  11. Wait about 20 seconds then refresh this page (the one you're following instructions from). GitHub Actions will automatically update to the next step.

Image

@ricardojfc ricardojfc added the bug Something isn't working label Oct 2, 2023
@ricardojfc ricardojfc changed the title [Bug] Step "run markdown lint" ends with en error [Bug] Step "Run markdown lint" ends with en error Oct 2, 2023
@Gabor12321
Copy link

the task: "Update the code in the ci branch to get the test to pass." Clue: on line 18 there is a file. the issue has something to do with markdown syntax. i personally asked chat gpt, and thats how i reached to the solution after a long time.. good luck!

@cmwilson21 cmwilson21 added the needs engineering Requires engineering-specific changes only. label Nov 8, 2023
@javeedambu
Copy link

javeedambu commented Nov 19, 2023

The following line is causing the warning and error

npx remark . --use remark-preset-lint-consistent --frail

The "." is asking to check all files for markdown syntax and its warning that "resume.md" is not following the syntax.

You can use "" or "*" to markdown as italics font.
However when you use "consisent" as in the code above, then you should only use either "
" or "" throughout the file.
"resume.md" started using "_" and then later it also used "
", hence the warning.
(ref:https://www.npmjs.com/package/remark-lint-emphasis-marker/v/3.1.0)

The "--frail" will exits as failed when there is a warnings.
(ref: Search for "--frail" in the URL:https://github.com/remarkjs/remark-lint)

In short if you where to replace *Git* with _Git_ in the "resume.md" then you will not have any errors.

But then we don't get to do the LAB as per the instructions provided.

Also the error Screenshots mentioned in Step2 - "Review required" and "Merging is blocked" never occurs, as there were no Branch rules already to cause this error.

If at the beginning of the Step1, we add a step to create a branch rule requiring one reviewer approval then we get this error when attempting to perform the pull request after creating the ci.yml.

@cmwilson21
Copy link
Contributor

Linking issue #48

@skills/technical-reviewers Would ya'll mind taking a look at this one? 👀 👍

@sinsukehlab
Copy link
Contributor

This error is intentional.

Even after the code is indented properly in ci.yml, you will see a build error in GitHub Actions. We'll fix this in the next step.

@hectorsector
Copy link

@sinsukehlab is right, but I agree that the instructions expect the learner to do a lot of heavy lifting with reading so I'll leave this open but it's feedback about the course structure mostly.

@gradybarrett
Copy link

gradybarrett commented Sep 16, 2024

@sinsukehlab is right, but I agree that the instructions expect the learner to do a lot of heavy lifting with reading so I'll leave this open but it's feedback about the course structure mostly.

This error is intentional.

I don't think this is the issue. The main issue is that the Step 2 guide is written with a frame a reference that speaks to unit (or other tests), not linting. So the person trying to follow along is left wondering where the tests are - spoiler, there are none.

I'm guessing this tutorial was originally written using test failures/fixes, but then ported to linting at some point? If so, step 2 was never updated to talk about linting instead of testing - including the workflow failure screenshots, which still show a matrix run and test failures, which causes even more confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working needs engineering Requires engineering-specific changes only.
Projects
None yet
Development

No branches or pull requests

7 participants