OpenSearch icon indicating copy to clipboard operation
OpenSearch copied to clipboard

Add Github Action to run ShellCheck

Open laysauchoa opened this issue 3 years ago • 47 comments

Description

Add GitHub action for ShellCheck to run on pull request.

Issues Resolved

https://github.com/opensearch-project/OpenSearch/issues/3343

Check List

  • [ ] New functionality includes testing.
    • [ ] All tests pass
  • [ ] New functionality has been documented.
    • [ ] New functionality has javadoc added
  • [x] Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

laysauchoa avatar Jul 28 '22 19:07 laysauchoa

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1086/
  • CommitID: 94d040d0ee0c26f20b27d24870b8cf83280b09e1

github-actions[bot] avatar Jul 28 '22 19:07 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: SUCCESS :white_check_mark:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1087/
  • CommitID: a7192d248b0174ada3c17bd78e0e9d53364a514e

github-actions[bot] avatar Jul 28 '22 20:07 github-actions[bot]

Codecov Report

Merging #4039 (bee6636) into main (6993ac9) will increase coverage by 0.02%. The diff coverage is n/a.

@@             Coverage Diff              @@
##               main    #4039      +/-   ##
============================================
+ Coverage     70.68%   70.71%   +0.02%     
- Complexity    57125    57154      +29     
============================================
  Files          4603     4603              
  Lines        274535   274535              
  Branches      40209    40209              
============================================
+ Hits         194058   194130      +72     
+ Misses        64196    64122      -74     
- Partials      16281    16283       +2     
Impacted Files Coverage Δ
.../java/org/opensearch/node/NodeClosedException.java 50.00% <0.00%> (-50.00%) :arrow_down:
...ch/transport/ReceiveTimeoutTransportException.java 50.00% <0.00%> (-50.00%) :arrow_down:
...nsearch/index/shard/IndexShardClosedException.java 66.66% <0.00%> (-33.34%) :arrow_down:
...opensearch/snapshots/SnapshotMissingException.java 28.57% <0.00%> (-28.58%) :arrow_down:
.../java/org/opensearch/index/reindex/RemoteInfo.java 51.37% <0.00%> (-27.53%) :arrow_down:
...opensearch/snapshots/SnapshotRestoreException.java 25.00% <0.00%> (-25.00%) :arrow_down:
...va/org/opensearch/monitor/process/ProcessInfo.java 68.00% <0.00%> (-24.00%) :arrow_down:
...search/aggregations/pipeline/HoltWintersModel.java 21.47% <0.00%> (-20.81%) :arrow_down:
...ain/java/org/opensearch/geometry/MultiPolygon.java 80.00% <0.00%> (-20.00%) :arrow_down:
...pensearch/test/rest/yaml/section/SetupSection.java 74.07% <0.00%> (-18.52%) :arrow_down:
... and 468 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

codecov-commenter avatar Jul 28 '22 20:07 codecov-commenter

@laysauchoa it seems like this particular Github action needs to be allowed explicitly:


Error: .github#L1
ludeeus/action-shellcheck@master is not allowed to be used in opensearch-project/OpenSearch. Actions in this workflow must be: within a repository that belongs to your Enterprise account, verified in the GitHub Marketplace, or matching the following: VachaShah/[email protected], lycheeverse/[email protected], stefanzweifel/[email protected], svanboxel/delete-merged-branch@main, tibdex/backport@v1, tibdex/[email protected], tim-actions/[email protected], tim-actions/[email protected], peter-evans/create-pull-request@v3, fernandrone/[email protected], peter-evans/create-issue-from-file@v4, peter-evans/create-or-update-comment@v2.

reta avatar Jul 28 '22 21:07 reta

@laysauchoa it seems like this particular Github action needs to be allowed explicitly:


Error: .github#L1
ludeeus/action-shellcheck@master is not allowed to be used in opensearch-project/OpenSearch. Actions in this workflow must be: within a repository that belongs to your Enterprise account, verified in the GitHub Marketplace, or matching the following: VachaShah/[email protected], lycheeverse/[email protected], stefanzweifel/[email protected], svanboxel/delete-merged-branch@main, tibdex/backport@v1, tibdex/[email protected], tim-actions/[email protected], tim-actions/[email protected], peter-evans/create-pull-request@v3, fernandrone/[email protected], peter-evans/create-issue-from-file@v4, peter-evans/create-or-update-comment@v2.

I'm working with @CEHENKLE to allow it.

owaiskazi19 avatar Jul 28 '22 22:07 owaiskazi19

@laysauchoa the GHA is added in the list. Can you push again to trigger it?

owaiskazi19 avatar Jul 28 '22 22:07 owaiskazi19

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1139/
  • CommitID: 1b566b1ea6992cb595caea2e812e2d8ab2d8f839

github-actions[bot] avatar Jul 30 '22 19:07 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1140/
  • CommitID: 97843d95acc638ce6009da9ca652ec46fa81d901

github-actions[bot] avatar Jul 30 '22 20:07 github-actions[bot]

@owaiskazi19 I pushed again, thank you! I am not sure it worked though

laysauchoa avatar Jul 30 '22 20:07 laysauchoa

@owaiskazi19 I pushed again, thank you! I am not sure it worked though

@laysauchoa no, it did not, @owaiskazi19 there is a typo in action name:

ludeeus/action-shellcheck@master is not allowed to be used in opensearch-project/OpenSearch. Actions in this workflow must be: within a repository that belongs to your Enterprise account, verified in the GitHub Marketplace, or matching the following: VachaShah/[email protected], lycheeverse/[email protected], stefanzweifel/[email protected], svanboxel/delete-merged-branch@main, tibdex/backport@v1, tibdex/[email protected], tim-actions/[email protected], tim-actions/[email protected], peter-evans/create-pull-request@v3, fernandrone/[email protected], peter-evans/create-issue-from-file@v4, peter-evans/create-or-update-comment@v2, ludeeus/action-shellcheck@maste.

Should be ludeeus/action-shellcheck@maste -> ludeeus/action-shellcheck@master it looks like

reta avatar Aug 01 '22 01:08 reta

Thanks @reta for looking into it. @laysauchoa the typo has been fixed. Feel free to push again

owaiskazi19 avatar Aug 03 '22 03:08 owaiskazi19

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1327/
  • CommitID: ac45b342b3912033fd47ff64533afaddc686186a

github-actions[bot] avatar Aug 03 '22 04:08 github-actions[bot]

@laysauchoa could you please rebase against latest main? thank you

reta avatar Aug 03 '22 11:08 reta

ping @reta done, thanks for reviewing

laysauchoa avatar Aug 03 '22 11:08 laysauchoa

ping @reta done, thanks for reviewing

@laysauchoa DCO checks is failing :( , could you please do git commit --amend --signoff and force push?

reta avatar Aug 03 '22 11:08 reta

my bad, I forgot to sign off! Works now, thanks @reta again

laysauchoa avatar Aug 03 '22 11:08 laysauchoa

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1348/
  • CommitID: b3c01a96b5edaf5d27ad6ca8667241873e1431f5

github-actions[bot] avatar Aug 03 '22 11:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1346/
  • CommitID: 921b218fc7aba1286e688ee4a247487339c6720a

github-actions[bot] avatar Aug 03 '22 11:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1350/
  • CommitID: 7d12dc37eca8223a6e3e527852e9a4ea22cede89

github-actions[bot] avatar Aug 03 '22 11:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1352/
  • CommitID: 1796daec691cd4782a0c816d7433e72066d941a5

github-actions[bot] avatar Aug 03 '22 12:08 github-actions[bot]

It is working!

Notice: ./gradlew:183:13: note: Double quote to prevent globbing and word splitting. [SC2086]
Notice: ./gradlew:183:31: note: Double quote to prevent globbing and word splitting. [SC2086]
Notice: ./gradlew:183:42: note: Double quote to prevent globbing and word splitting. [SC2086]

We probably need to add gradlew to exclusions list since it is not managed by OpenSearch (comes from Gradle)

reta avatar Aug 03 '22 12:08 reta

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1353/
  • CommitID: 9777b9ef17df83474dd0d22e49b83811d9466eac

github-actions[bot] avatar Aug 03 '22 12:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1503/
  • CommitID: 9777b9ef17df83474dd0d22e49b83811d9466eac

github-actions[bot] avatar Aug 05 '22 19:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1528/
  • CommitID: 9df567caab229ce36f6e4bf8d8f115e90cf1efa3

github-actions[bot] avatar Aug 07 '22 07:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1529/
  • CommitID: 1adb0c5547fd4d43113dbfea0aa9adc780bbeab1

github-actions[bot] avatar Aug 07 '22 09:08 github-actions[bot]

@laysauchoa could you please rebase against origin/main? the Jenkins builds are failing because your branch is far behind

reta avatar Aug 07 '22 14:08 reta

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1534/
  • CommitID: 4796f190df8fdba6cab1be9a65a7cb0552dbd91c

github-actions[bot] avatar Aug 07 '22 15:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1536/
  • CommitID: aea729dce35d2d3aba78b68637a3c71e71b5b6dc

github-actions[bot] avatar Aug 07 '22 15:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: FAILURE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1535/
  • CommitID: 52bb4039da714917b00276e7fb4828ba92c5ce8b

github-actions[bot] avatar Aug 07 '22 15:08 github-actions[bot]

Gradle Check (Jenkins) Run Completed with:

  • RESULT: UNSTABLE :x:
  • URL: https://build.ci.opensearch.org/job/gradle-check/1532/
  • CommitID: 08db8b41eb311b63a40a603596b9bfe90eb102fc

github-actions[bot] avatar Aug 07 '22 16:08 github-actions[bot]