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.

Sign up for GitHub

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

Jump to bottom

Add source code linting to Groovy code and Jenkinsfile(s) #320

Open
dblock opened this issue Nov 16, 2021 · 3 comments
Open

Add source code linting to Groovy code and Jenkinsfile(s) #320

dblock opened this issue Nov 16, 2021 · 3 comments
Assignees
@chawinphat
Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Global event that encourages people to contribute to open-source.

Comments

@dblock
Copy link
Member

dblock commented Nov 16, 2021

Is your feature request related to a problem? Please describe

Add source code linting to Groovy code and Jenkinsfile(s)

Describe the solution you'd like

Code in src/jenkins and tests/jenkins, along with Jenkinsfile in jenkins/*.

  • Documentation on how to lint in DEVELOPER_GUIDE.
  • Pre-commit hook.
  • Linting that fails CI if the code is not properly formatted.

Describe alternatives you've considered

No response

Additional context

No response
@dblock dblock added enhancement New feature or request good first issue Good for newcomers untriaged labels Nov 16, 2021
@bbarani bbarani added the hacktoberfest Global event that encourages people to contribute to open-source. label Oct 5, 2022
@chawinphat
Copy link

I'm interested in working on this issue.

@gaiksaya
Copy link
Member

gaiksaya commented Oct 3, 2023

Moving this issue to build-libraries repo since all groovy code has been moved there.

@gaiksaya gaiksaya transferred this issue from opensearch-project/opensearch-build Oct 3, 2023
@chawinphat
Copy link

I found this https://github.com/nvuillam/npm-groovy-lint/blob/master/README.md which seems to work quite well. The problem is that the build-libraries repository does not have npm installed.

We can also use jenkins pipeline development tools to lint jenkinsfiles https://www.jenkins.io/doc/book/pipeline/development/.

@chawinphat chawinphat mentioned this issue Oct 15, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@chawinphat chawinphat

Labels
enhancement New feature or request good first issue Good for newcomers hacktoberfest Global event that encourages people to contribute to open-source.
Projects
Engineering Effectiveness Board
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
5 participants
@dblock @abhinavGupta16 @gaiksaya @bbarani @chawinphat