Skip to content

Commit 3ca0d06

Browse files
committed
start a development docu
1 parent 73797ed commit 3ca0d06

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

development.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
# ![HtmlUnitDriver Logo](https://github.com/SeleniumHQ/htmlunit-driver/blob/master/htmlunit_webdriver.png)
2+
3+
## HtmlUnitDriver Development
4+
5+
These instructions will get you a copy of the project up and running on your local machine
6+
for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
7+
8+
### Prerequisites
9+
10+
You simply only need a local maven installation.
11+
12+
13+
### Building
14+
15+
Create a local clone of the repository and you are ready to start.
16+
17+
Open a command line window from the root folder of the project and call
18+
19+
```
20+
mvn compile
21+
```
22+
23+
### Running the tests
24+
25+
```
26+
mvn test
27+
```
28+
29+
## Contributing
30+
31+
Pull Requests and all other Community Contributions are essential for open source software.
32+
Every contribution - from bug reports to feature requests, typos to full new features - are greatly appreciated.
33+
34+
## Deployment and Versioning
35+
36+
This part is intended for committer who are packaging a release.
37+
38+
* Check all your files are checked in
39+
* Execute these mvn commands to be sure all tests are passing and everything is up to data
40+
41+
```
42+
mvn versions:display-plugin-updates
43+
mvn versions:display-dependency-updates
44+
mvn -U clean test
45+
```
46+
47+
* Update the version number in pom.xml and README.md
48+
* Commit the changes
49+
50+
51+
* Build and deploy the artifacts
52+
53+
```
54+
mvn -up clean deploy
55+
```
56+
57+
* Go to [Maven Central Portal](https://central.sonatype.com/) and process the deploy
58+
- publish the package and wait until it is processed
59+
60+
* Create the version on GitHub
61+
* login to GitHub and open project https://github.com/HtmlUnit/htmlunit-cssparser
62+
* click Releases > Draft new release
63+
* fill the tag and title field with the release number (e.g. 4.0.0)
64+
* append/ the build artifacts and
65+
* publish the release
66+
67+
* Update the version number in pom.xml to start next snapshot development
68+
* Update the htmlunit pom to use the new release

0 commit comments

Comments
 (0)