Jenkins Editor

Add this URL to your Eclipse Installation to reach this solution's update site.

2022-03 (4.23), 2021-12 (4.22), 2021-09 (4.21), 2021-06 (4.20), 2021-03 (4.19), 2020-12 (4.18), 2020-09 (4.17), 2020-06 (4.16), 2020-03 (4.15), 2019-12 (4.14), 2019-09 (4.13), 2019-06 (4.12), 2019-03 (4.11), 2018-12 (4.10), 2018-09 (4.9), Photon (4.8), Oxygen (4.7), Neon (4.6), 2022-06 (4.24), 2022-09 (4.25), 2022-12 (4.26), 2023-03 (4.27), 2023-06 (4.28), 2023-09 (4.29), 2023-12 (4.30)

https://de-jcup.github.io/update-site-eclipse-jenkins-editor/update-site/

Learn more...
Solution Description

Overview

Jenkins editor is just a jenkins build script editor plugin for eclipse

Features

  • Code completion and tooltips (for Jenkins DSL)
  • Syntax highlighting, customizable colors, pre defined default for Dark Theme
  • Groovy syntax validation
  • Validate by Jenkins Linter directly from editor by context menu or toolbar
  • Replay pipeline script and/or fetch latest log from pipeline build by main toolbar actions
  • Own console for log outputs
  • Execute jenkins-cli actions by editor console toolbar action
  • Bracket switching (CTRL + p)
  • Outline + Quick outline (CTRL + o) for declarative pipelines
  • Block commenting (CTRL + 7)
  • Todo Task support
  • File associations to "Jenkinsfile", "*.jenkins", "*.jenkinsfile"
  • Shortcut buttons In preferences to create new API tokens and to download new jenkins-cli.jar directly

Where can I get more information about the plugin ?

Please look into

What has changed between releases, what's new ?

Please look into Release history (GitHub)

Categories: Build and Deploy, Editor, Tools

Additional Details

Eclipse Versions: 2022-03 (4.23), 2021-12 (4.22), 2021-09 (4.21), 2021-06 (4.20), 2021-03 (4.19), 2020-12 (4.18), 2020-09 (4.17), 2020-06 (4.16), 2020-03 (4.15), 2019-12 (4.14), 2019-09 (4.13), 2019-06 (4.12), 2019-03 (4.11), 2018-12 (4.10), 2018-09 (4.9), Photon (4.8), Oxygen (4.7), Neon (4.6), 2022-06 (4.24), 2022-09 (4.25), 2022-12 (4.26), 2023-03 (4.27), 2023-06 (4.28), 2023-09 (4.29), 2023-12 (4.30)

Platform Support: Windows, Mac, Linux/GTK

Organization Name: Albert Tregnaghi

Development Status: Production/Stable

Date Created: Thursday, September 28, 2017 - 18:05

License: Apache 2.0

Date Updated: Friday, October 6, 2023 - 10:48

Submitted by: Albert Tregnaghi

Screenshot
Date Ranking Installs Clickthroughs
December 2023 0/0 0 1
November 2023 76/686 660 23
October 2023 58/673 807 24
September 2023 57/663 762 13
August 2023 53/673 761 14
July 2023 50/668 831 18
June 2023 52/669 871 20
May 2023 59/671 844 18
April 2023 61/667 804 20
March 2023 49/686 1345 15
February 2023 46/667 1159 24
January 2023 55/675 1040 33
View Data for all Listings

Unsuccessful Installs

Unsuccessful Installs in the last 7 Days: 5

Download last 500 errors (CSV)

Marketplace Drag to Install Button

By adding the following code below to your website you will be able to add an install button for Jenkins Editor.

HTML Code:

Markdown Syntax:

Output:

Drag to your running Eclipse* workspace. *Requires Eclipse Marketplace Client

Reviews Add new review

This plugin is simply amazing. Please don't stop to develop it. Jenkins pipelines are a complex task to write and this plugin makes this task a little bit easier.

In reply to by Renato Perini

Hello Renato,

nice that you like the plugin so much. I started the development of this plugin because of same problems you mentioned before while I was using Jenkins a lot. In the meantime I am using still Jenkins but more and more other build environments. So new ideas for Jenkins-Plugin will not "pop up" automatically .

If you want new features or report bugs, please report those to issue tracker (https://github.com/de-jcup/eclipse-jenkins-editor/issues ).

Since I just don't have enough time and hardly use the plugin myself, I can't promise that I will implement every issue, but at least I try to keep the plugin installable in the marketplace, fix bugs, etc. But if you want a new feature , maybe someone else will implement the issue on github.

Best wishes
Albert

Because of bintray sundown we need a new update site URL.

For Yaml Editor and Bash Editor we allready have the change. When will this happen for Jenkinsfile?

In reply to by Frank Becker

Hello Frank,

Jenkins editor depends internally on EGradle core and I try to provide some additional features before releasing new versions, so I didn't "just migrate" update sites.

I have migrated 6 of 10 de-jcup plugin update-sites to new locations - with new features. The missing  4 plugins are currently: Asciidoctor-Editor (+ASP library) ,EGradle, Jenkins-Editor and EKube.

At https://jfrog.com/blog/into-the-sunset-bintray-jcenter-gocenter-and-cha… is (now) mentioned:

"To clarify, the JCenter repository will keep serving packages for 12 months until February 1st 2022. Only the JCenter REST API and UI will be sunsetted on May 1st 2021."

Anyway, I have planned to migrate all missing plugins to new update-site locations till 30.04.2021 - but I have no exact time line.

In reply to by sikku mishra

I just tested - and the plugin is no longer available. I did not change anything, but
https://bintray.com/de-jcup only 3 repositories listed any longer: yamleditor, sqleditor, test-generic
but not this one - OMG. I have no idea why this happened - it seems this is an issue at bintray.
Nevertheless I will migrate as soon as possible and provide a new update url at marketplace.

Sorry for the inconvenience!

In reply to by sikku mishra

Hello, I just released Version 1.8.0 - which is released on new location.

Just open the marketplace client in your eclipse. The new version will show up and you can update to here. After installation is done new update location is automatically set.

See also https://github.com/de-jcup/eclipse-jenkins-editor/issues/78

Hi - I had asked that already a while ago but got no response, so I am asking again:

The Jenkinsfile Editor does syntax highlighting but that seems to be it. Is that really all it's supposed to do?
I had expected some syntax validation, you write that it supports code completion, but it obviously does not. I also had expected at least some basic validations (e.g. warnings on unused variable, superfluous ';' and similar stuff). Shouldn't it do that? Any idea why none of these features is working in my environment?

This is on eclipse 2020-12.

In reply to by Michael Moser

Hello Michael,

The editor can -indeed-  more than just syntax highlighting.

Here is a YouTube video which shows code completion and tooltips live in action.
Please look at GitHub project site for feature descriptions and also issue tracker.

Groovy language problems will be recognized and shown, Detailed information about script problems can be viewed by calling the linter mechanism over the UI. Please ensure you really opened the jenkins file with Jenkins Editor. If you still have more questions/problems , please add issues by the github issue tracker

 

Hi,

I tried the jenkins linter several times but all I get is 'Jenkins CLI call failed' so my guess it, the plugin forgets to store the credentials from the settings dialog somewhere.

First some information about my setup: I am running a jenkins-server 2.249.2 on a server on my network. In my user settings on jenkins I created an API token. Then I switched to my eclipse (9090-09 with jenkins editor 1.7.0), opened the settings of jenkins editor, checked the jenkins URL, added my user name in 'credentials' and added my API token. Once I pressed 'Test connection' and got the message 'Connection test successful'.

Whatever I do next: press 'apply' first or directly 'apply and close', whenever I try to lint a jenkinsfile all I get is 'Jenkins CLI call failed' with the following message in the details view:

"JenkinsLinterCLIResult:
- exitCode:-2 (Linter was not executed at all)
- failureMessage:Access to Jenkins was not possible by command:

java -jar C:\Apps\jenkins-cli\jenkins-cli.jar -s %URL_NOT_ALLOWED_HERE% -http -noCertificateCheck -auth null:******* declarative-linter

Maybe credentials not valid or hostname/firewall problems.
Please check Jenkins CLI setup in preferences
-Output was:

"

 

BTW: when I copied the command line java -jar blabla to a cmd window and replaced the pair 'null:****' with my actual user/API-token and pasted a jenkinsfile to the console I got: 'Jenkinsfile successfully validated.'

So my idea about lost settings seems quite valid.

Could you please fix this?

Best regards,
Christoph

In reply to by Christoph Fetzer

Hello Christoph,

sorry for the late response but I am very busy since beginning of last year.
I created GitHub issue #81 for this problem.

Your given output has shown that there was no authentication (user was null). Maybe you did not setup Jenkins preferences? Setup is described at Wiki

If you have additional information/thoughts, please add them at the mentioned GitHub issue.

Best wishes
Albert

The Jenkins-Editor works as text editor and does some basic syntax highlighting, but it doesn't seem to "know" or recognize that the Jenkinsfile is actually Groovy code and hence it doesn't provide the corresponding language support.

E.g. when commenting a range it prefixes the text with '#' instead of '//', which produces illgal syntax. I would also have expected that it offers the corresponding support like code completions, variable names when writing expressions, etc. etc.

Is there something one can add or adjust to make that happen?

In reply to by senthil kumar

Hello,

I just tried out with a fresh Eclipse 2019-09 R (4.13.0), Build 20190917-1200 . I installed jenkins editor 1.7.0 by eclipse marketplace. Did work well without any problems. Maybe your problem was a temporary issue at bintray, so please try again.

If there are still any problems, please report an issue at https://github.com/de-jcup/eclipse-jenkins-editor/issues

Best wishes
Albert

Hi,

Does it require or have a dependency with Groovy Eclipse? If it does not, do I still get any advantage from using Groovy Eclipse together wth Jenkins Editor?

Thank you.

In reply to by Juan Antonio F…

It does not require groovy eclipse. Jenkins editor has no dependency at all .

Advantages when having groovy eclipse with jenkins : You could try to create library parts in separate .groovy files and include them in jenkinsfile. So you could code groovy parts with eclipse groovy editors and the jenkins part would just do jenkins stuff...

My company security does not permit installing from Eclipse plug-ins via the Marketplace client.  Do you make available a binary to install this plug-in offline?  Thanks for any assistance you can provide.