[JEP-222] Add experimental WebSocket support + Jetty update in Winstone + Remoting 4.0

.github/PULL_REQUEST_TEMPLATE.md

@@ -21,11 +21,15 @@ If the issue is not fully described in the ticket, add more information here (ju
 <!-- Comment: 
 The changelogs will be integrated by the core maintainers after the merge.  See the changelog examples here: https://jenkins.io/changelog/ -->
 
+### Proposed upgrade guidelines
+
+N/A
+
 ### Submitter checklist
 
 - [ ] JIRA issue is well described
-- [ ] Changelog entry appropriate for the audience affected by the change (users or developer, depending on the change). [Examples](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)
-      * Use the `Internal: ` prefix if the change has no user-visible impact (API, test frameworks, etc.)
+- [ ] Changelog entries and upgrade guidelines are appropriate for the audience affected by the change (users or developer, depending on the change). [Examples](https://github.com/jenkins-infra/jenkins.io/blob/master/content/_data/changelogs/weekly.yml)
+  * Fill-in the `Proposed changelog entries` section only if there are breaking changes or other changes which may require extra steps from users during the upgrade
 - [ ] Appropriate autotests or explanation to why this change has no tests
 - [ ] For dependency updates: links to external changelogs and, if possible, full diffs
 
@@ -38,3 +42,15 @@ The changelogs will be integrated by the core maintainers after the merge.  See
 <!-- Comment:
 If you need an accelerated review process by the community (e.g., for critical bugs), mention @jenkinsci/code-reviewers
 -->
+
+### Maintainer checklist
+
+Before the changes are marked as `ready-for-merge`: 
+
+- [ ] There are at least 2 approvals for the pull request and no outstanding requests for change
+- [ ] Conversations in the pull request are over OR it is explicit that a reviewer does not block the change
+- [ ] Changelog entries in the PR title and/or `Proposed changelog entries` are correct
+- [ ] Proper changelog labels are set so that the changelog can be generated automatically
+- [ ] If the change needs additional upgrade steps from users, `upgrade-guide-needed` label is set and there is a `Proposed upgrade guidelines` section in the PR title. ([example](https://github.com/jenkinsci/jenkins/pull/4387))
+- [ ] If it would make sense to backport the change to LTS, a JIRA issue should exist and be labeled as `lts-candidate`
+

.github/release-drafter.yml

@@ -1,29 +1,18 @@
 # Configuration for Release Drafter: https://github.com/toolmantim/release-drafter
-name-template: $NEXT_PATCH_VERSION
-# Uses a more common 2-digit versioning in Jenkins weekly releases.
+_extends: .github
+# We use the 2-digit versioning in Jenkins weekly releases.
 version-template: $MAJOR.$MINOR
+name-template: $NEXT_MINOR_VERSION
 tag-template: jenkins-$NEXT_MINOR_VERSION
 
-exclude-labels:
-  - reverted
-  - no-changelog
-  - skip-changelog
-  - invalid
-change-template: |-
-  - type: todo
-    message: |-
-      $TITLE
-    pull: $NUMBER
-    authors:
-      - $AUTHOR
-
 template: |
   **Disclaimer**: This is an automatically generated changelog draft for Jenkins weekly releases. 
-  See https://jenkins.io/changelog/ for the official changelogs. 
+  See https://jenkins.io/changelog/ for the official changelogs.
+  For `changelog.yaml` drafts see GitHub action artifacts attached to release commits.
 
-  ```yaml
   $CHANGES
-  ```
+
+  All contributors: $CONTRIBUTORS
 
 # Categories will be commented out, because we use YAML
 # Now we use categories only for sorting
@@ -44,17 +33,3 @@ categories:
     label: developer
   - title: Internal changes
     label: internal
-
-replacers:
-  - search: '/\[*JENKINS-(\d+)\]*\s*-*\s*/g'
-    replace: |-
-      issue: $1
-        message: |-
-
-  - search: |-
-      message: |-
-          issue:
-    replace: "issue:"
-
-  - search: "##"
-    replace: "#"

.github/workflows/changelog.yml

@@ -0,0 +1,43 @@
+# Automates creation of changelog drafts using Release Drafter
+# More Info: https://github.com/jenkinsci/.github/blob/master/.github/release-drafter.adoc
+name: Changelog Drafter
+
+on:
+  push:
+    # branches to consider in the event; optional, defaults to all
+    branches:
+      - master
+
+jobs:
+  update_draft_release:
+    runs-on: ubuntu-latest
+    steps:
+      # Drafts your next Release notes as Pull Requests are merged into "master"
+      - name: Generate GitHub Release Draft
+        id: release-drafter
+        uses: release-drafter/release-drafter@v5.6.0
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      # Generates a YAML changelog file using https://github.com/jenkinsci/jenkins-core-changelog-generator
+      - name: Generate YAML changelog draft
+        id: jenkins-core-changelog-generator
+        uses: jenkinsci/jenkins-core-changelog-generator@master
+        env:
+          GITHUB_AUTH: github-actions:${{ secrets.GITHUB_TOKEN }}
+      - name: Upload Changelog YAML
+        uses: actions/upload-artifact@v1
+        with:
+          name: changelog.yaml
+          path: changelog.yaml
+#TODO(oleg-nenashev): It will not work well with Release Drafter which does not recreated releases. Asset does not get overwritten, and there is no ready-to-go API for overriding assets
+      # Upload YAML to the release draft assets
+#      - name: Upload changelog.yaml to the Release Draft
+#        id: upload-changelog-yaml
+#        uses: actions/upload-release-asset@v1.0.1
+#        env:
+#          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#        with:
+#          upload_url: ${{ steps.release-drafter.outputs.upload_url }}
+#          asset_path: ./changelog.yaml
+#          asset_name: changelog.yaml
+#          asset_content_type: text/yaml

CONTRIBUTING.md

@@ -31,24 +31,23 @@ There is a description of the [building and debugging process].
 
 If you want simply to have the `jenkins.war` file as fast as possible without tests, run:
 
-    mvn clean package -pl war -am -DskipTests -Dspotbugs.skip
+```sh
+mvn -am -pl war,bom -DskipTests -Dspotbugs.skip clean install
+```
 
 The WAR file will be created in `war/target/jenkins.war`.
 After that you can start Jenkins using Java CLI ([guide]).
 If you want to debug this WAR file without using Maven plugins,
 You can just start the executable with [Remote Debug Flags]
 and then attach IDE Debugger to it.
 
-To compile and launch a development instance, run:
+To launch a development instance, after the above command run:
 
-    mvn hudson-dev:run
+```sh
+mvn -pl war jetty:run
+```
 
-<!--
-This should be `mvn hudson-dev:run` as long as JENKINS-23364 is not resolved.
-For jenkis-dev:run it is currently necessary to add `org.jenkins-ci.tools` as a plugin group
-to the maven settings.xml.
-See also https://github.com/jenkinsci/jenkins/pull/4331#discussion_r341041470
--->
+(Beware that `maven-plugin` builds will not work in this mode due to class loading conflicts.)
 
 ## Testing changes
 

Jenkinsfile

@@ -43,7 +43,7 @@ for(j = 0; j < jdks.size(); j++) {
                                     "MAVEN_OPTS=-Xmx1536m -Xms512m"], buildType, jdk) {
                             // Actually run Maven!
                             // -Dmaven.repo.local=… tells Maven to create a subdir in the temporary directory for the local Maven repository
-                            def mvnCmd = "mvn -Pdebug -U -Dset.changelist help:evaluate -Dexpression=changelist -Doutput=$changelistF clean install ${runTests ? '-Dmaven.test.failure.ignore' : '-DskipTests'} -V -B -Dmaven.repo.local=$m2repo -s settings-azure.xml -e"
+                            def mvnCmd = "mvn -Pdebug -U -Dset.changelist help:evaluate -Dexpression=changelist -Doutput=$changelistF clean install ${runTests ? '-Dmaven.test.failure.ignore' : '-DskipTests'} -V -B -ntp -Dmaven.repo.local=$m2repo -s settings-azure.xml -e"
 
                             if(isUnix()) {
                                 sh mvnCmd
@@ -77,7 +77,6 @@ for(j = 0; j < jdks.size(); j++) {
 
 // TODO: Restore ATH once https://groups.google.com/forum/#!topic/jenkinsci-dev/v9d-XosOp2s is resolved
 // TODO: ATH flow now supports Java 8 only, it needs to be reworked (INFRA-1690)
-/*
 builds.ath = {
     node("docker&&highmem") {
         // Just to be safe
@@ -88,7 +87,7 @@ builds.ath = {
             checkout scm
             withMavenEnv(["JAVA_OPTS=-Xmx1536m -Xms512m",
                           "MAVEN_OPTS=-Xmx1536m -Xms512m"], 8) {
-                sh "mvn --batch-mode --show-version -DskipTests -am -pl war package -Dmaven.repo.local=${pwd tmp: true}/m2repo -s settings-azure.xml"
+                sh "mvn --batch-mode --show-version -Dorg.slf4j.simpleLogger.log.org.apache.maven.cli.transfer.Slf4jMavenTransferListener=warn -DskipTests -am -pl war package -Dmaven.repo.local=${pwd tmp: true}/m2repo -s settings-azure.xml"
             }
             dir("war/target") {
                 fileUri = "file://" + pwd() + "/jenkins.war"
@@ -99,7 +98,7 @@ builds.ath = {
             runATH jenkins: fileUri, metadataFile: metadataPath
         }
     }
-}*/
+}
 
 builds.failFast = failFast
 parallel builds

bom/pom.xml

@@ -148,11 +148,11 @@ THE SOFTWARE.
         <artifactId>servlet-api</artifactId>
         <version>[0]</version>
         <!-- 
-              "[0]" is a range that must be exaclty 0
+              "[0]" is a range that must be exactly 0
               this is different to "0" which is hint to use version 0.
               therefore unless anyone else uses ranges (they should not) this version will always win
               We have deployed a version 0 to jenkins repo which has an empty jar
-              This prevents conflicts between the old Servet API and the new Servlet API as the groupIDs have changed
+              This prevents conflicts between the old Servlet API and the new Servlet API as the groupIDs have changed
               see https://github.com/jenkinsci/jenkins/pull/3033/files#r141325857 for a fuller description
         -->
         <scope>provided</scope>

cli/pom.xml

@@ -16,6 +16,7 @@
   <properties>
     <!-- TODO: remove once Medium level is set in the core (JENKINS-36716) -->
     <findbugs.threshold>Medium</findbugs.threshold>
+    <junit.jupiter.version>5.5.2</junit.jupiter.version>
   </properties>
 
   <dependencyManagement>
@@ -31,26 +32,38 @@
   </dependencyManagement>
 
   <dependencies>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <version>${junit.jupiter.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <version>${junit.jupiter.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter</artifactId>
+      <version>${junit.jupiter.version}</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
         <groupId>org.kohsuke</groupId>
         <artifactId>access-modifier-annotation</artifactId>
+        <scope>provided</scope>
     </dependency>
     <dependency>
       <groupId>org.jenkins-ci</groupId>
       <artifactId>annotation-indexer</artifactId>
-    </dependency>
-    <dependency>
-      <groupId>commons-codec</groupId>
-      <artifactId>commons-codec</artifactId>
+      <optional>true</optional>
     </dependency>
     <dependency>
       <groupId>commons-io</groupId>
       <artifactId>commons-io</artifactId>
-    </dependency>
-    <dependency>
-      <groupId>${project.groupId}</groupId>
-      <artifactId>remoting</artifactId>
-      <!-- specified in the parent -->
+      <optional>true</optional>
     </dependency>
     <dependency>
       <groupId>junit</groupId>
@@ -61,61 +74,88 @@
       <groupId>org.jvnet.localizer</groupId>
       <artifactId>localizer</artifactId>
       <version>1.26</version>
+      <optional>true</optional>
     </dependency>
     <dependency>
       <groupId>org.apache.sshd</groupId>
       <artifactId>sshd-core</artifactId>
       <version>1.7.0</version>
-      <optional>true</optional> <!-- do not expose to core -->
+      <optional>true</optional>
+    </dependency>
+    <!-- ed25519 algorithm, see JENKINS-45318 -->
+    <dependency>
+      <groupId>net.i2p.crypto</groupId>
+      <artifactId>eddsa</artifactId>
+      <version>0.3.0</version>
+      <optional>true</optional>
     </dependency>
-	<!-- ed25519 algorithm, see JENKINS-45318 -->
-	<dependency>
-  	  <groupId>net.i2p.crypto</groupId>
-	  <artifactId>eddsa</artifactId>
-	  <version>0.3.0</version>
-	</dependency>
     <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-jdk14</artifactId>
-      <optional>true</optional> <!-- ditto -->
+      <optional>true</optional>
+    </dependency>
+    <dependency>
+      <groupId>org.glassfish.tyrus.bundles</groupId>
+      <artifactId>tyrus-standalone-client-jdk</artifactId>
+      <version>1.12</version>
+      <optional>true</optional>
     </dependency>
     <dependency>
       <groupId>com.github.spotbugs</groupId>
       <artifactId>spotbugs-annotations</artifactId>
-      <optional>true</optional>
+      <scope>provided</scope>
     </dependency>
     <dependency>
       <groupId>commons-lang</groupId>
       <artifactId>commons-lang</artifactId>
+      <optional>true</optional>
     </dependency>
   </dependencies>
 
   <build>
     <plugins>
       <plugin>
-        <artifactId>maven-assembly-plugin</artifactId>
-        <!-- version specified in grandparent pom -->
-        <executions>
-          <execution>
-            <goals>
-              <goal>single</goal>
-            </goals>
-            <phase>package</phase>
-            <configuration>
-              <descriptorRefs>
-                <descriptorRef>jar-with-dependencies</descriptorRef>
-              </descriptorRefs>
-              <archive>
-                <manifest>
-                  <mainClass>hudson.cli.CLI</mainClass>
-                </manifest>
-                <manifestEntries>
-                  <Jenkins-CLI-Version>${project.version}</Jenkins-CLI-Version>
-                </manifestEntries>
-              </archive>
-            </configuration>
-          </execution>
-        </executions>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>2.22.2</version>
+      </plugin>
+      <plugin>
+          <groupId>org.apache.maven.plugins</groupId>
+          <artifactId>maven-shade-plugin</artifactId>
+          <version>3.2.1</version>
+          <executions>
+              <execution>
+                  <phase>package</phase>
+                  <goals>
+                      <goal>shade</goal>
+                  </goals>
+                  <configuration>
+                      <createDependencyReducedPom>false</createDependencyReducedPom>
+                      <relocations>
+                          <relocation>
+                              <pattern>javax.websocket</pattern>
+                              <shadedPattern>io.jenkins.cli.shaded.javax.websocket</shadedPattern>
+                          </relocation>
+                          <relocation>
+                              <pattern>org</pattern>
+                              <shadedPattern>io.jenkins.cli.shaded.org</shadedPattern>
+                          </relocation>
+                          <relocation>
+                              <pattern>net</pattern>
+                              <shadedPattern>io.jenkins.cli.shaded.net</shadedPattern>
+                          </relocation>
+                      </relocations>
+                      <transformers>
+                          <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                              <mainClass>hudson.cli.CLI</mainClass>
+                              <manifestEntries>
+                                  <Jenkins-CLI-Version>${project.version}</Jenkins-CLI-Version>
+                              </manifestEntries>
+                          </transformer>
+                          <transformer implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/>
+                      </transformers>
+                  </configuration>
+              </execution>
+          </executions>
       </plugin>
       <plugin>
         <groupId>org.jvnet.localizer</groupId>