- 
          
 - 
                Notifications
    
You must be signed in to change notification settings  - Fork 9.2k
 
Update the ReadMe #11147
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.
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
base: master
Are you sure you want to change the base?
Update the ReadMe #11147
Changes from 1 commit
a75360d
              84bcf99
              c3a4966
              61ac74c
              fcc70cd
              2858eb4
              f518623
              74ce300
              e6a4130
              1d9d563
              File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| 
          
            
          
           | 
    @@ -2,19 +2,38 @@ | |||||
| <img width="400" src="https://www.jenkins.io/images/jenkins-logo-title-dark.svg" alt="Jenkins logo"> | ||||||
| </a> | ||||||
| 
     | 
||||||
| # About | ||||||
| 
     | 
||||||
| [](https://www.jenkins.io/changelog) | ||||||
| [](https://www.jenkins.io/changelog-stable) | ||||||
| [](https://hub.docker.com/r/jenkins/jenkins/) | ||||||
| [](https://bestpractices.coreinfrastructure.org/projects/3538) | ||||||
| [](https://maven.apache.org/guides/mini/guide-reproducible-builds.html) | ||||||
| [](https://app.gitter.im/#/room/#jenkinsci_jenkins:gitter.im) | ||||||
| 
     | 
||||||
| --- | ||||||
| 
     | 
||||||
| # 📌 Table of Contents | ||||||
| 
     | 
||||||
| - [About](#about) | ||||||
| - [What to Use Jenkins for and When to Use It](#what-to-use-jenkins-for-and-when-to-use-it) | ||||||
| - [Downloads](#downloads) | ||||||
| - [Getting Started (Development)](#getting-started-development) | ||||||
| - [Source](#source) | ||||||
| - [Contributing to Jenkins](#contributing-to-jenkins) | ||||||
| - [News and Website](#news-and-website) | ||||||
| - [Governance](#governance) | ||||||
| - [Adopters](#adopters) | ||||||
| - [License](#license) | ||||||
| - [Screenshots](#screenshots) | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| 
     | 
||||||
| --- | ||||||
| 
     | 
||||||
| # About | ||||||
| 
     | 
||||||
| In a nutshell, Jenkins is the leading open-source automation server. | ||||||
| Built with Java, it provides over 2,000 [plugins](https://plugins.jenkins.io/) 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: | ||||||
| 
        
          
        
         | 
    @@ -39,36 +58,148 @@ For all distributions Jenkins offers two release lines: | |||||
| Older release line which gets periodically updated via bug fix backports. | ||||||
| 
     | 
||||||
| Latest releases: | ||||||
| 
     | 
||||||
| [](https://www.jenkins.io/changelog) | ||||||
| [](https://www.jenkins.io/changelog-stable) | ||||||
| 
     | 
||||||
| # Getting Started (Development) | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
          
            Show resolved
            Hide resolved
         | 
||||||
| 
     | 
||||||
| To build and run Jenkins locally from source, follow these steps: | ||||||
| 
     | 
||||||
| ### 1. Clone the Repository | ||||||
| 
     | 
||||||
| ```bash | ||||||
| git clone https://github.com/jenkinsci/jenkins.git | ||||||
| cd jenkins | ||||||
| ``` | ||||||
| ### 2. Build the Project | ||||||
| Use Maven to compile and package Jenkins: | ||||||
| ```bash | ||||||
| mvn clean install -DskipTests | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| ``` | ||||||
| To run tests during the build, omit the ```-DskipTests``` flag. | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| > The build may take several minutes, depending on your system and internet speed. | ||||||
| 
     | 
||||||
| ### 3. Run Jenkins | ||||||
| Once built, you can launch Jenkins using: | ||||||
| ```bash | ||||||
| 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. | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| - Logs will be shown in the console to help with debugging. | ||||||
| - You can access the initial admin password in: | ||||||
| ```bash | ||||||
| ~/.jenkins/secrets/initialAdminPassword | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| ``` | ||||||
| If port 8080 is in use, run Jenkins on another port: | ||||||
| ```bash | ||||||
| java -jar war/target/jenkins.war --httpPort=9090 | ||||||
| ``` | ||||||
| 
     | 
||||||
| ### 5. Troubleshooting | ||||||
| OutOfMemoryError: Try increasing memory limits: | ||||||
| ```bash | ||||||
| MAVEN_OPTS="-Xmx2g -XX:MaxPermSize=512m" | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| ``` | ||||||
| - Permission issues on Unix/macOS: use sudo or ensure correct ownership of files. | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| - Build fails on tests: Try a clean rebuild: | ||||||
| ```bash | ||||||
| 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` | | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| 
     | 
||||||
| 
     | 
||||||
| 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/](https://www.jenkins.io/doc/developer/) | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| 
     | 
||||||
| 
     | 
||||||
| # Source | ||||||
| 
     | 
||||||
| Our latest and greatest source of Jenkins can be found on [GitHub](https://github.com/jenkinsci/jenkins). Fork us! | ||||||
| 
     | 
||||||
| # Contributing to Jenkins | ||||||
| 
     | 
||||||
| Follow the [contributing guidelines](CONTRIBUTING.md) if you want to propose a change in the Jenkins core. | ||||||
| New to open source or Jenkins? Here’s how to get started: | ||||||
| 
     | 
||||||
| - Check our [Good First Issues](https://github.com/jenkinsci/jenkins/contribute) | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| - Join our Gitter chat for questions and help | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| - Read the [Contribution Guidelines](CONTRIBUTING.md) | ||||||
| 
     | 
||||||
| For more information about participating in the community and contributing to the Jenkins project, | ||||||
| see [this page](https://www.jenkins.io/participate/). | ||||||
| 
     | 
||||||
| Documentation for Jenkins core maintainers is in the [maintainers guidelines](docs/MAINTAINERS.adoc). | ||||||
| 
     | 
||||||
| # News and Website | ||||||
| 
     | 
||||||
| All information about Jenkins can be found on our [website](https://www.jenkins.io/). | ||||||
| Follow us on [Twitter](https://twitter.com/jenkinsci) or [LinkedIn](https://www.linkedin.com/company/jenkins-project/). | ||||||
| All information about Jenkins can be found on our [official website](https://www.jenkins.io/), including documentation, blog posts, plugin listings, community updates, and more. | ||||||
| 
     | 
||||||
| Stay up-to-date with the latest Jenkins news, tutorials, and release notes: | ||||||
| 
     | 
||||||
| - [Jenkins Blog](https://www.jenkins.io/blog/) | ||||||
| - [Documentation](https://www.jenkins.io/doc/) | ||||||
| - [Plugins Index](https://plugins.jenkins.io/) | ||||||
| - [Events](https://www.jenkins.io/events/) | ||||||
| - [Newsletter](https://www.jenkins.io/newsletter/) | ||||||
| 
     | 
||||||
| Follow Jenkins on social media to stay connected with the community: | ||||||
| 
     | 
||||||
| - [Twitter / X](https://twitter.com/jenkinsci) | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| - [YouTube](https://www.youtube.com/c/jenkinsci) | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| - [GitHub](https://github.com/jenkinsci/jenkins) | ||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| 
     | 
||||||
| # Governance | ||||||
| 
     | 
||||||
| See the [Jenkins Governance Document](https://www.jenkins.io/project/governance/) for information about the project's open governance, our philosophy and values, and development practices. | ||||||
| Jenkins Code of Conduct can be found [here](https://www.jenkins.io/project/conduct/). | ||||||
| The Jenkins project is governed as an open source community, led by a [governance board](https://www.jenkins.io/project/governance/) 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: | ||||||
| 
     | 
||||||
| - [Governance Document](https://www.jenkins.io/project/governance/) | ||||||
| - [Code of Conduct](https://www.jenkins.io/project/conduct/) | ||||||
| - [Security Policy](https://www.jenkins.io/security/) | ||||||
| - [Project Roadmap](https://www.jenkins.io/project/roadmap/) | ||||||
| 
     | 
||||||
                
      
                  Vyzer9 marked this conversation as resolved.
               
              
                Outdated
          
            Show resolved
            Hide resolved
         | 
||||||
| 
     | 
||||||
| # Adopters | ||||||
| 
     | 
||||||
| Jenkins is used by millions of users and thousands of companies. | ||||||
| See [adopters](https://www.jenkins.io/project/adopters/) for the list of Jenkins adopters and their success stories. | ||||||
| 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. | ||||||
| 
         There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Personal opinion: not sure about that change, the "adopted" seems a bit strange to me (then english is not my native language) Also, do we really want those em-dashes? 😅  | 
||||||
| 
     | 
||||||
| Explore the [Adopters Page](https://www.jenkins.io/project/adopters/) to see: | ||||||
                
       | 
||||||
| Explore the [Adopters Page](https://www.jenkins.io/project/adopters/) to see: | |
| Explore the [Adopters Page](https://www.jenkins.io/project/adopters/) and https://stories.jenkins.io to see: | 
suggestion: add stories.jenkins.io link
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Personal opinion: there is currently no emoji on the README, I would avoid adding one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll leave it to the reader's eyes, it makes it easier and provides more clarity, but I'll remove it as you asked.