Skip to content

README.md

Latest commit

 

History

History
205 lines (144 loc) · 7.99 KB

README.md

File metadata and controls

205 lines (144 loc) · 7.99 KB
Jenkins logo

Jenkins Regular Release Jenkins LTS Release Docker Pulls CII Best Practices Reproducible Builds Gitter

📌 Table of Contents

About

In a nutshell, Jenkins is the leading open-source automation server. Built with Java, it provides over 2,000 plugins to support automating virtually anything, so that humans can spend their time doing things machines cannot.

What to Use Jenkins for and When to Use It

Use Jenkins to automate your development workflow, so you can focus on work that matters most. Jenkins is commonly used for:

  • Building projects
  • Running tests to detect bugs and other issues as soon as they are introduced
  • Static code analysis
  • Deployment

Execute repetitive tasks, save time, and optimize your development process with Jenkins.

Downloads

The Jenkins project provides official distributions as WAR files, Docker images, native packages and installers for platforms including several Linux distributions and Windows. See the Downloads page for references.

For all distributions Jenkins offers two release lines:

  • Weekly - Frequent releases which include all new features, improvements, and bug fixes.
  • Long-Term Support (LTS) - Older release line which gets periodically updated via bug fix backports.

Latest releases:

Jenkins Regular Release Jenkins LTS Release

Getting Started (Development)

To build and run Jenkins locally from source, follow these steps:

1. Clone the Repository

git clone https://github.com/jenkinsci/jenkins.git
cd jenkins

2. Build the Project

Use Maven to compile and package Jenkins:

mvn clean install -DskipTests

To run tests during the build, omit the -DskipTests flag.

The build may take several minutes, depending on your system and internet speed.

3. Run Jenkins

Once built, you can launch Jenkins using:

java -jar war/target/jenkins.war

Jenkins will start on http://localhost:8080 by default.

⚠️ Make sure Java 11 or higher and Apache Maven are installed and available in your PATH.

4. Developer Tips

  • Use mvn hpi:run to start Jenkins in development mode with hot-reload support for plugins.
  • Logs will be shown in the console to help with debugging.
  • You can access the initial admin password in:
~/.jenkins/secrets/initialAdminPassword

If port 8080 is in use, run Jenkins on another port:

java -jar war/target/jenkins.war --httpPort=9090

5. Troubleshooting

OutOfMemoryError: Try increasing memory limits:

MAVEN_OPTS="-Xmx2g -XX:MaxPermSize=512m"
  • Permission issues on Unix/macOS: use sudo or ensure correct ownership of files.
  • Build fails on tests: Try a clean rebuild:
mvn clean install -DskipTests

6. Useful Commands

Task Command
Clean build mvn clean install -DskipTests
Run with tests mvn clean install
Start in dev mode mvn hpi:run
Run unit tests only mvn test
Build WAR only mvn package -DskipTests

For more information on setting up your development environment, contributing, and working with Jenkins internals, check the official Jenkins Developer Documentation: ➡️ https://www.jenkins.io/doc/developer/

Source

Our latest and greatest source of Jenkins can be found on GitHub. Fork us!

Contributing to Jenkins

New to open source or Jenkins? Here’s how to get started:

For more information about participating in the community and contributing to the Jenkins project, see this page.

Documentation for Jenkins core maintainers is in the maintainers guidelines.

News and Website

All information about Jenkins can be found on our official website, including documentation, blog posts, plugin listings, community updates, and more.

Stay up-to-date with the latest Jenkins news, tutorials, and release notes:

Follow Jenkins on social media to stay connected with the community:

Governance

The Jenkins project is governed as an open source community, led by a governance board and supported by a large network of maintainers and contributors.

Our governance is based on the following principles:

  • Open and transparent decision-making
  • Community-driven leadership
  • Empowering contributors and plugin maintainers

We encourage all participants to read and follow our:

Adopters

Jenkins is trusted by millions of users and adopted by thousands of companies around the world — from startups to enterprises — to automate their software delivery pipelines.

Explore the Adopters Page to see:

  • Companies and organizations using Jenkins
  • Success stories and case studies
  • How Jenkins is used in different industries

If your company uses Jenkins and you'd like to be featured, feel free to submit your story!

License

Jenkins is licensed under the MIT License.

Screenshots

WebSite

image

Documentation

image