Skip to content

fix: text parameter from file #70

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

Merged
merged 1 commit into from
Jan 21, 2025
Merged

Conversation

2color
Copy link
Contributor

@2color 2color commented Jan 21, 2025

Background

inlined cating of a file in the curl command can cause problems with shell escape characters. Especially if the text/markdown file at hand is large and contains a lot of special characters like [this example from the IPFS Docs, where I discovered this bug]https://github.com/ipfs/ipfs-docs/blob/84a4445592a6763796f92aa972d0a529e8d193c3/docs/reference/kubo/cli.md).

This causes the problems mentioned in #32

What's in this PR

This changes uses the fieldname@filename pattern in Curl to have CURL load the contents of the file.

This fixes #32 and has been confirmed to work in https://github.com/ipfs/ipfs-docs/actions/runs/12884342273/job/35920448036#step:4:448

@2color
Copy link
Contributor Author

2color commented Jan 21, 2025

@haya14busa Any chance you can take a look at this?

@haya14busa haya14busa merged commit c3b05d4 into reviewdog:master Jan 21, 2025
9 checks passed
@review-dog
Copy link
Member

Hi, @2color! We merged your PR to reviewdog! 🐶
Thank you for your contribution! ✨

We just invited you to join the @reviewdog organization on GitHub.
Accept the invite by visiting https://github.com/orgs/reviewdog/invitation.
By joining the team, you'll be a part of reviewdog community and can help the maintenance of reviewdog.

Thanks again!

Copy link
Contributor

🚀 [bumpr] Bumped! New version:v1.20.1 Changes:v1.20.0...v1.20.1

@Isengo1989
Copy link

Hey, we recently started to get errors that stops the pipeline on empty index.md files (for structural reasons).

This seems related

image

@2color
Copy link
Contributor Author

2color commented Jan 21, 2025

@Isengo1989 can you please try #71

Can you check if that file it's checking is empty? It's strange that Curl is not sending an emptytext parameter as it should.

You can try it by updating the branch name in your workflow to skip-empty

@Isengo1989
Copy link

Hey @2color - yes this seems to fix it. Here is a PR using that branch

https://github.com/shopware/docs/actions/runs/12903720329/job/35979487619?pr=1664

and as a reference a branch with default v1 failing

https://github.com/shopware/docs/actions/runs/12903760139/job/35979605655?pr=1665

@2color
Copy link
Contributor Author

2color commented Jan 22, 2025

#71 has been merged. So this should be fine! Thanks for reporting.

@Isengo1989
Copy link

#71 has been merged. So this should be fine! Thanks for reporting.

Great 👍 Thanks for the quick reply and fix 🙂

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

Successfully merging this pull request may close these issues.

Argument list too long occurred when the file is exceed the limit.
4 participants