|
| 1 | +# HtmlUnit - Websocket-Client |
| 2 | + |
| 3 | +This is the code repository of the WebSocket support used by HtmlUnit. |
| 4 | + |
| 5 | +The default WebSocket client used by HtmlUnit is based on Jetty 9. To avoid conflicts in projects |
| 6 | +using different versions of Jetty, this repo provides a shaded version of the jetty websocket stuff. |
| 7 | + |
| 8 | +[](https://maven-badges.herokuapp.com/maven-central/org.htmlunit/htmlunit-websocket-client) |
| 9 | + |
| 10 | +:heart: [Sponsor](https://github.com/sponsors/rbri) |
| 11 | + |
| 12 | +### Project News |
| 13 | + |
| 14 | +[HtmlUnit@mastodon][4] | [HtmlUnit@Twitter][3] |
| 15 | + |
| 16 | +### Latest release Version 4.1.0 / April 28, 2024 |
| 17 | + |
| 18 | +### Maven |
| 19 | + |
| 20 | +Add to your `pom.xml`: |
| 21 | + |
| 22 | +```xml |
| 23 | +<dependency> |
| 24 | + <groupId>org.htmlunit</groupId> |
| 25 | + <artifactId>htmlunit-websocket-client</artifactId> |
| 26 | + <version>4.1.0</version> |
| 27 | +</dependency> |
| 28 | +``` |
| 29 | + |
| 30 | +### Gradle |
| 31 | + |
| 32 | +Add to your `build.gradle`: |
| 33 | + |
| 34 | +```groovy |
| 35 | +implementation group: 'org.htmlunit', name: 'htmlunit-websocket-client', version: '4.1.0' |
| 36 | +``` |
| 37 | + |
| 38 | +### Last CI build |
| 39 | +The latest builds are available from our |
| 40 | +[Jenkins CI build server][2] |
| 41 | + |
| 42 | +[](https://jenkins.wetator.org/job/HtmlUnit%20-%20XPath/) |
| 43 | + |
| 44 | +If you use maven please add: |
| 45 | + |
| 46 | + <dependency> |
| 47 | + <groupId>org.htmlunit</groupId> |
| 48 | + <artifactId>htmlunit-websocket-client</artifactId> |
| 49 | + <version>4.2.0-SNAPSHOT</version> |
| 50 | + </dependency> |
| 51 | + |
| 52 | +You have to add the sonatype snapshot repository to your pom `repositories` section also: |
| 53 | + |
| 54 | + <repository> |
| 55 | + <id>OSS Sonatype snapshots</id> |
| 56 | + <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url> |
| 57 | + <snapshots> |
| 58 | + <enabled>true</enabled> |
| 59 | + <updatePolicy>always</updatePolicy> |
| 60 | + </snapshots> |
| 61 | + <releases> |
| 62 | + <enabled>false</enabled> |
| 63 | + </releases> |
| 64 | + </repository> |
| 65 | + |
| 66 | + |
| 67 | +## Start HtmlUnit - XPath Development |
| 68 | + |
| 69 | +These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. |
| 70 | +See deployment for notes on how to deploy the project on a live system. |
| 71 | + |
| 72 | +### Prerequisites |
| 73 | + |
| 74 | +You simply only need a local maven installation. |
| 75 | + |
| 76 | + |
| 77 | +### Building |
| 78 | + |
| 79 | +Create a local clone of the repository and you are ready to start. |
| 80 | + |
| 81 | +Open a command line window from the root folder of the project and call |
| 82 | + |
| 83 | +``` |
| 84 | +mvn compile |
| 85 | +``` |
| 86 | + |
| 87 | +### Running the tests |
| 88 | + |
| 89 | +``` |
| 90 | +mvn test |
| 91 | +``` |
| 92 | + |
| 93 | +## Contributing |
| 94 | + |
| 95 | +Pull Requests and and all other Community Contributions are essential for open source software. |
| 96 | +Every contribution - from bug reports to feature requests, typos to full new features - are greatly appreciated. |
| 97 | + |
| 98 | +## Deployment and Versioning |
| 99 | + |
| 100 | +This part is intended for committer who are packaging a release. |
| 101 | + |
| 102 | +* Check all your files are checked in |
| 103 | +* Execute these mvn commands to be sure all tests are passing and everything is up to data |
| 104 | + |
| 105 | +``` |
| 106 | + mvn versions:display-plugin-updates |
| 107 | + mvn versions:display-dependency-updates |
| 108 | + mvn -U clean test |
| 109 | +``` |
| 110 | + |
| 111 | +* Update the version number in pom.xml and README.md |
| 112 | +* Commit the changes |
| 113 | + |
| 114 | + |
| 115 | +* Build and deploy the artifacts |
| 116 | + |
| 117 | +``` |
| 118 | + mvn -up clean deploy |
| 119 | +``` |
| 120 | + |
| 121 | +* Go to [Sonatype staging repositories](https://s01.oss.sonatype.org/index.html#stagingRepositories) and process the deploy |
| 122 | + - select the repository and close it - wait until the close is processed |
| 123 | + - release the package and wait until it is processed |
| 124 | + |
| 125 | +* Create the version on Github |
| 126 | + * login to Github and open project https://github.com/HtmlUnit/htmlunit-xpath |
| 127 | + * click Releases > Draft new release |
| 128 | + * fill the tag and title field with the release number (e.g. 4.0.0) |
| 129 | + * append |
| 130 | + * htmlunit-xpath-4.x.x.jar |
| 131 | + * htmlunit-xpath-4.x.x.jar.asc |
| 132 | + * htmlunit-xpath-4.x.x-javadoc.jar |
| 133 | + * htmlunit-xpath-4.x.x-javadoc.jar.asc |
| 134 | + * and publish the release |
| 135 | + |
| 136 | +* Update the version number in pom.xml to start next snapshot development |
| 137 | +* Update the htmlunit pom to use the new release |
| 138 | + |
| 139 | +## Authors |
| 140 | + |
| 141 | +* **RBRi** |
| 142 | +* all the contributors to Xalan |
| 143 | + |
| 144 | +## License |
| 145 | + |
| 146 | +This project is licensed under the Apache 2.0 License |
| 147 | + |
| 148 | +## Acknowledgments |
| 149 | + |
| 150 | +Many thanks to all of you contributing to HtmlUnit/CSSParser/Rhino in the past. |
| 151 | + |
| 152 | + |
| 153 | +[2]: https://jenkins.wetator.org/job/HtmlUnit%20-%20XPath/ "HtmlUnit - XPath CI" |
| 154 | +[3]: https://twitter.com/HtmlUnit "https://twitter.com/HtmlUnit" |
| 155 | +[4]: https://fosstodon.org/@HtmlUnit |
0 commit comments