Blue Ocean is the next generation user experience for Jenkins. You can learn more about its features and roadmap on the Blue Ocean project website.
Get Blue Ocean
Blue Ocean is available from the Jenkins update center for Jenkins 2.7.1 and above.
Reporting bugs and feature requests
It is a multi-module maven project made up of a few Jenkins plugins. There is an aggregator plugin in the "blueocean" module.
CONTRIBUTIONS ALWAYS WELCOME NO MATTER HOW BIG OR SMALL.
Some background reading: https://jenkins.io/blog/2016/05/26/introducing-blue-ocean/
This is in the main Update Center for Jenkins. Install the plugin called "BlueOcean beta" (and let it install its dependencies). The instructions here are for contributors to Blue Ocean and the morbidly curious. Expect refactoring.
Modules of note
A quick tour of some of the modules (not all). Consult README.md in respective modules for more info.
An aggregator plugin, making it an easy place from which to run Blue Ocean via
Java interfaces and classes that specify the definition of the REST API that blueocean uses. See the README.md within this module for detail on this api.
Provides the default implementation of the core REST Apis defined in the
blueocean-rest plugin. It comes with only freestyle job support.
Provides implementation of Pipeline apis for Jenkins pipeline and multi-branch job types support
Building and running
Build everything (from root directory)
Builds all maven modules (run this the first time you check things out, at least)
$ mvn clean install
For now, you'll need to skip the tests if building on Windows, so be sure to include the
-DskipTests switch e.g.
$ mvn clean install -DskipTests
Running Blue Ocean
$ mvn -f blueocean/pom.xml hpi:run
Then open http://localhost:8080/jenkins/blue to start using Blue Ocean.
The Jenkins Classic UI exists side-by-side at its usual place at http://localhost:8080/jenkins.
The obviously goal is for Blue Ocean to be runnable on all browsers on all platforms. We're not there yet, but getting closer. The ultimate goal will be to have browser support in line with the Jenkins Browser Compatibility Matrix.
List of browsers where we know Blue Ocean is not yet runnable:
Internet Explorer < 11 on Windows (the aim is to keep IE 11 working, but help is needed to maintain a Windows test environment in the pipeline)
Follow the steps above for getting it running first.
Look in following README's for:
blueocean-dashboardguide on how to modify the GUI in the dashboard plugin. https://github.com/cloudbees/blueocean-sample-pipeline-result-ext-plugin has a video/sample of a plugin that extends Blue Ocean.
blueocean-restfor how to navigate the rest api.
blueocean-rest-implfor more details on how to actively develop this plugin for backend codebases.
Building plugins for Blue Ocean
The best way to get started is to look at the tutorial and Yeoman starter project here: https://www.npmjs.com/package/generator-blueocean-usain The usual plugin guide also applies for Jenkins: https://wiki.jenkins-ci.org/display/JENKINS/Plugin+tutorial#Plugintutorial-CreatingaNewPlugin
Ask for help in #jenkins-ci or on the mailing list if you are working on a plugin.
NOTE: look in the README.md of the respective modules for more detailed dev docs.
NPM and shrinkwrap
- Ensure your npm is 3.10.8+ as this release fixes some important bugs with shrinkwrap, notably #11735 in notes
- Don't edit package.json directly; use npm install to ensure that both package.json and npm-shrinkwrap.json are updated.
- To add or update a dependency:
npm install packageName@3.2.1 -S -E
- To add or update a devDependency:
npm install packageName@3.2.1 -D -E
- If you are handling a merge conflict in package.json, resolve the conflict in the file as normal. Then use the appropriate command to update each conflicting dependency to ensure shrinkwrap is updated.
- To remove a dependency:
npm uninstall packageName -S
- To remove a devDependency:
npm uninstall packageName -D
- If you ever need to create a shrinkwrap for the first time, use
npm shrinkwrap --devto ensure devDependencies are included in the shrinkwrap.
In case you want to update your dependencies with something like
npm-check-updates make sure you follow the simple steps:
ncu -a rm -rf node_modules npm-shrinkwrap.json npm i npm shrinkwrap --dev
Contributing - help wanted
i18n - Sprechen Sie Deutsch?
We have full i18n support in our plugins. Please read the i18n documentation on how you can provide new translations and how to work with i18n.
Want to get involve with blueocean? See our contributing guidelines for more informations.
Debug and live reload with IntelliJ
Automatically deploys changes to an instance of blueocean that is run with hpi:run.
- Enable class reloading: Preferences > Build, Execution, Deployment > Debugger > HotSwap
- Reload classes in background
- Reload classes after compilation: always
- Create a Maven Run/Debug configuration
- Working Directory:
- Runner > Properties: Enable Skip tests
- Runner > VM Options:
- Working Directory:
- Debug new configuration, and after compilation the class file will be reloaded
You can chat to folks on #jenkins-ux on freenode (IRC). You can also email the jenkins-dev email list (google group: https://groups.google.com/forum/#!forum/jenkinsci-dev) - but ensure you use the prefix [Blue Ocean] in your subject line when posting.
Advanced front end development with react, redux and stuff by @scherler: https://docs.google.com/presentation/d/1dbaYTIGjGT9xX1JnWnaqjMumq94M9nGwljfMQaVtUFc/edit?usp=sharing
Watch @i386 and @jenkinsci on Twitter for frequent updates and news.