-
Notifications
You must be signed in to change notification settings - Fork 949
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
fix: correct shell script format via shellcheck reports #1447
fix: correct shell script format via shellcheck reports #1447
Conversation
Signed-off-by: Allen Sun <[email protected]>
Signed-off-by: zhuangqh <[email protected]>
Nice! |
related to #1437 |
Codecov Report
@@ Coverage Diff @@
## master #1447 +/- ##
==========================================
+ Coverage 16.26% 37.5% +21.24%
==========================================
Files 206 254 +48
Lines 13759 17368 +3609
==========================================
+ Hits 2238 6514 +4276
+ Misses 11365 10023 -1342
- Partials 156 831 +675
|
--description 'Pouch is an open-source project created by Alibaba Group to promote the container technology movement. | ||
|
||
Pouchs vision is to advance container ecosystem and promote container standards OCI, so that container technologies become the foundation for application development in the Cloud era. | ||
Pouch'"'"'s vision is to advance container ecosystem and promote container standards OCI, so that container technologies become the foundation for application development in the Cloud era. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do not think this change is correct.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This change aims to display single quote correctly. @allencloud
related link: https://stackoverflow.com/questions/1250079/how-to-escape-single-quotes-within-single-quoted-strings
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh, I see. This is not just doc, but a string in shell script. My fault.
tar xf $TMP/containerd-1.0.3.linux-amd64.tar.gz -C $TMP && | ||
cp -f $TMP/bin/* /usr/local/bin/ | ||
https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P "$TMP" | ||
tar xf "$TMP/containerd-1.0.3.linux-amd64.tar.gz" -C "$TMP" && |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think in the future we need to make this version configurable at the head of this file rather than hard coding here. And all the 1.0.3
things should use the variable.
@@ -48,19 +47,19 @@ function build_pouch() | |||
{ | |||
# install containerd | |||
echo "Downloading containerd." | |||
wget --quiet https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P $TMP | |||
tar xf $TMP/containerd-1.0.3.linux-amd64.tar.gz -C $TMP && cp -f $TMP/bin/* $BINDIR/ | |||
wget --quiet https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P "$TMP" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also this place, there is hard coding
wget --quiet https://github.com/alibaba/runc/releases/download/v1.0.0-rc4-1/runc.amd64 -P $BINDIR/ | ||
chmod +x $BINDIR/runc.amd64 | ||
mv $BINDIR/runc.amd64 $BINDIR/runc | ||
wget --quiet https://github.com/alibaba/runc/releases/download/v1.0.0-rc4-1/runc.amd64 -P "$BINDIR/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
also here, hard coding
LGTM since I take a quick review of this. However, I still wish to invite @ZouRui89 to take a thorough review of this. Thanks a lot. |
wget --quiet https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P $TMP | ||
tar xf $TMP/containerd-1.0.3.linux-amd64.tar.gz -C $TMP && cp -f $TMP/bin/* $BINDIR/ | ||
wget --quiet https://github.com/containerd/containerd/releases/download/v1.0.3/containerd-1.0.3.linux-amd64.tar.gz -P "$TMP" | ||
tar xf "$TMP/containerd-1.0.3.linux-amd64.tar.gz -C $TMP && cp -f $TMP/bin/* $BINDIR/" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There should double quote one by one, or won't work.😅
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will fix this in another PR, together with the problem of hardcode.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@zhuangqh cool!
Ⅰ. Describe what this PR did
This PR help pouch to pass the ShellCheck (https://github.com/koalaman/shellcheck). There is a short report.
SC2086 Double quote to prevent globbing and word splitting 94 fail(s)
SC2046 Quote this to prevent word splitting 8 fail(s)
SC2034 POUCH_SOCK appears unused. Verify it or export it 7 fail(s)
SC2039 In POSIX sh, 'pushd' is not supported 6 fail(s)
SC2148 Tips depend on target shell and yours is unknown. Add a shebang 5 fail(s)
SC2112 'function' keyword is non-standard. Delete it 4 fail(s)
SC2016 Expressions don't expand in single quotes, use double quotes for that 3 fail(s)
SC2006 Use $(..) instead of legacy
..
2 fail(s)SC2129 Consider using { cmd1; cmd2; } >> file instead of individual redirects 1 fail(s)
SC2071 < is for string comparisons. Use -lt instead 1 fail(s)
SC2068 Double quote array expansions, otherwise they're like $* and break on spaces 1 fail(s)
SC2064 Use single quotes, otherwise this expands now rather than when signalled 1 fail(s)
You can find the detailed rules here
Ⅱ. Does this pull request fix one issue?
Ⅲ. Describe how you did it
Ⅳ. Describe how to verify it
ShellCheck don't report error.
Shell script still works fine.
Ⅴ. Special notes for reviews
In rule SC2086