You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@accumulo.apache.org by GitBox <gi...@apache.org> on 2022/05/04 22:29:14 UTC
[GitHub] [accumulo] ctubbsii opened a new pull request, #2677: Run shfmt and shellcheck on scripts
ctubbsii opened a new pull request, #2677:
URL: https://github.com/apache/accumulo/pull/2677
* Run shfmt to format scripts
* Run shellcheck to check all scripts for bugs
* Add automated check for shfmt and shellcheck during CI
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] ctubbsii commented on pull request #2677: Run shfmt and shellcheck on scripts
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on PR #2677:
URL: https://github.com/apache/accumulo/pull/2677#issuecomment-1118005717
All the modified tools need to be checked to ensure they didn't break, but they shouldn't have. This is mostly automated formatting. Some shellcheck fixes were trivial, but others were a bit more involved. If necessary, I can split out the formatting and trivial shellcheck changes from the more involved ones, to make narrow down what actually needs to be tested.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] ctubbsii commented on a diff in pull request #2677: Run shfmt and shellcheck on scripts
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on code in PR #2677:
URL: https://github.com/apache/accumulo/pull/2677#discussion_r866250757
##########
contrib/ci/run-shellcheck.sh:
##########
@@ -0,0 +1,27 @@
+#! /usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+# Run ShellCheck on all bash scripts
+
+set -e
+set -x
+
+mapfile -t filestocheck < <(shfmt -f .)
+shellcheck -P SCRIPTDIR -x "${filestocheck[@]}"
Review Comment:
It will run shellcheck against all files found by `shfmt -f .`, which is run at the root of the project. It's pretty good at finding shell files, even if they don't have `.sh` filename extensions.
`SCRIPTDIR` is a special flag that causes shellcheck to use the directives `#shellcheck source=<path>` with a `<path>` relative to each script's directory rather than relative to the current working directory where you ran the shellcheck program. It's not a variable.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] ctubbsii merged pull request #2677: Run shfmt and shellcheck on scripts
Posted by GitBox <gi...@apache.org>.
ctubbsii merged PR #2677:
URL: https://github.com/apache/accumulo/pull/2677
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] ctubbsii commented on a diff in pull request #2677: Run shfmt and shellcheck on scripts
Posted by GitBox <gi...@apache.org>.
ctubbsii commented on code in PR #2677:
URL: https://github.com/apache/accumulo/pull/2677#discussion_r866250757
##########
contrib/ci/run-shellcheck.sh:
##########
@@ -0,0 +1,27 @@
+#! /usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+# Run ShellCheck on all bash scripts
+
+set -e
+set -x
+
+mapfile -t filestocheck < <(shfmt -f .)
+shellcheck -P SCRIPTDIR -x "${filestocheck[@]}"
Review Comment:
It will run shellcheck against all files found by `shfmt -f .`, which is run at the root of the project. It's pretty good at finding shell files, even if they don't have `.sh` filename extensions.
`SCRIPTDIR` is a special flag that causes shellcheck to use the directives `#shellcheck source=<path>` with a relative `<path>`. It's not a variable.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [accumulo] milleruntime commented on a diff in pull request #2677: Run shfmt and shellcheck on scripts
Posted by GitBox <gi...@apache.org>.
milleruntime commented on code in PR #2677:
URL: https://github.com/apache/accumulo/pull/2677#discussion_r865858253
##########
contrib/ci/run-shellcheck.sh:
##########
@@ -0,0 +1,27 @@
+#! /usr/bin/env bash
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+# Run ShellCheck on all bash scripts
+
+set -e
+set -x
+
+mapfile -t filestocheck < <(shfmt -f .)
+shellcheck -P SCRIPTDIR -x "${filestocheck[@]}"
Review Comment:
So this will just run shellcheck on the contrib directory? Or all files? I don't see where `SCRIPTDIR` is set...
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@accumulo.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org