Skip to content

Commit d0e9588

Browse files
committed
Merge correct commit; need to test using JDK 17
1 parent 8619cdc commit d0e9588

File tree

1 file changed

+21
-12
lines changed

1 file changed

+21
-12
lines changed

readme.md

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -30,21 +30,30 @@ StubParser. Only developers, not users, of StubParser need to do this.
3030
1. Fork [the StubParser project](https://github.com/typetools/stubparser) to your GitHub account.
3131
2. Clone the repository, using *one* of the following two commands:
3232

33-
```sh
34-
git clone git@github.com:{user.name}/stubparser.git
35-
git clone https://github.com/{user.name}/stubparser
36-
```
33+
```sh
34+
git clone git@github.com:{user.name}/stubparser.git
35+
git clone https://github.com/{user.name}/stubparser
36+
```
37+
38+
and then `cd`:
39+
```sh
40+
cd stubparser
41+
```
42+
3. Use JDK 17. For example:
43+
```sh
44+
usejdk17
45+
```
3746

3847
### Updating
3948

4049
1. Update from StubParser.
4150
```sh
42-
cd stubparser
4351
git pull --ff-only https://github.com/typetools/stubparser
4452
```
4553
2. Find an appropriate [tag name](https://github.com/javaparser/javaparser/tags):
4654
```sh
47-
export TAG_NAME=javaparser-parent-3.24.7
55+
export VER=3.27.1
56+
export TAG_NAME=javaparser-parent-${VER}
4857
```
4958
3. Create and checkout a new branch, via ONE of the below:
5059
```sh
@@ -53,16 +62,18 @@ git clone https://github.com/{user.name}/stubparser
5362
or (alternate version):
5463
```sh
5564
gnb updating-${TAG_NAME}
56-
cd ../stubparser-branch-updating-${TAG_NAME}
65+
cd ../stubparser-fork-${USER}-branch-updating-${TAG_NAME}
5766
```
5867
4. Pull the upstream of [the JavaParser project](https://github.com/javaparser/javaparser).
5968
```sh
60-
git pull https://github.com/javaparser/javaparser ${TAG_NAME}
69+
git remote add upstream https://github.com/javaparser/javaparser
70+
git fetch upstream
71+
git merge ${TAG_NAME}
6172
```
6273
5. If there are conflicts, resolve them and commit (but don't push yet).
6374
6. Update the StubParser version number in the `<finalName>` block of `javaparser-core/pom.xml`.
6475
(There should not be "-SNAPSHOT" there or in `<version>` in the top-level `pom.xml`.)
65-
7. Run Maven tests in the root directory:
76+
7. Run Maven tests in the root directory, using JDK 17. This takes about 2 minutes.
6677
```sh
6778
./mvnw install test
6879
```
@@ -72,7 +83,7 @@ git clone https://github.com/{user.name}/stubparser
7283
Update the `version` block in `javaparser-core/cfMavenCentral.xml` to be the same as the
7384
JavaParser version plus `-SNAPSHOT`. Run the following in `javaparser-core`
7485
```sh
75-
export STUBPARSER=stubparser-3.25.5
86+
export STUBPARSER=stubparser-${VER}
7687
export HOSTING_INFO_DIR=/projects/swlab1/checker-framework/hosting-info
7788
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
7889
-DpomFile=cfMavenCentral.xml -Dfile=target/$STUBPARSER.jar\
@@ -138,7 +149,6 @@ If any tests fail, fix them before continuing.
138149

139150
17. Merge both pull requests when both pass.
140151

141-
142152
## Changes to StubParser that break the Checker Framework
143153

144154
If you commit a change to the StubParser that breaks the Checker Framework,
@@ -148,7 +158,6 @@ not for minor bug fixes), because it breaks the `mvn javadoc:javadoc` command.
148158
* In the Checker Framework's top-level `build.gradle` file, on the
149159
`stubparserJar =` line.
150160

151-
152161
## Original JavaParser README
153162

154163
The remainder of this README file is the original JavaParser README.

0 commit comments

Comments
 (0)