Skip to content

Commit 8619cdc

Browse files
mernstmernst
committed
Fix indentation
1 parent d6a2e11 commit 8619cdc

File tree

1 file changed

+67
-67
lines changed

1 file changed

+67
-67
lines changed

‎readme.md‎

Lines changed: 67 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -38,103 +38,103 @@ git clone https://github.com/{user.name}/stubparser
3838
### Updating
3939

4040
1. Update from StubParser.
41-
```sh
42-
cd stubparser
43-
git pull --ff-only https://github.com/typetools/stubparser
44-
```
41+
```sh
42+
cd stubparser
43+
git pull --ff-only https://github.com/typetools/stubparser
44+
```
4545
2. Find an appropriate [tag name](https://github.com/javaparser/javaparser/tags):
46-
```sh
47-
export TAG_NAME=javaparser-parent-3.24.7
48-
```
46+
```sh
47+
export TAG_NAME=javaparser-parent-3.24.7
48+
```
4949
3. Create and checkout a new branch, via ONE of the below:
50-
```sh
51-
git checkout -b updating-${TAG_NAME}
52-
```
50+
```sh
51+
git checkout -b updating-${TAG_NAME}
52+
```
53+
or (alternate version):
5354
```sh
5455
gnb updating-${TAG_NAME}
5556
cd ../stubparser-branch-updating-${TAG_NAME}
5657
```
5758
4. Pull the upstream of [the JavaParser project](https://github.com/javaparser/javaparser).
58-
```sh
59-
git pull https://github.com/javaparser/javaparser ${TAG_NAME}
60-
```
59+
```sh
60+
git pull https://github.com/javaparser/javaparser ${TAG_NAME}
61+
```
6162
5. If there are conflicts, resolve them and commit (but don't push yet).
6263
6. Update the StubParser version number in the `<finalName>` block of `javaparser-core/pom.xml`.
6364
(There should not be "-SNAPSHOT" there or in `<version>` in the top-level `pom.xml`.)
6465
7. Run Maven tests in the root directory:
65-
```sh
66-
./mvnw install test
67-
```
68-
If any tests fail, fix them before continuing.
66+
```sh
67+
./mvnw install test
68+
```
69+
If any tests fail, fix them before continuing.
6970

7071
8. Deploy the snapshot. (This has been tested on tern.)
71-
Update the `version` block in `javaparser-core/cfMavenCentral.xml` to be the same as the
72-
JavaParser version plus `-SNAPSHOT`. Run the following in `javaparser-core`
73-
```
74-
export STUBPARSER=stubparser-3.25.5
75-
export HOSTING_INFO_DIR=/projects/swlab1/checker-framework/hosting-info
76-
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
77-
-DpomFile=cfMavenCentral.xml -Dfile=target/$STUBPARSER.jar\
78-
-Dgpg.keyname=checker-framework-dev@googlegroups.com \
79-
-Dgpg.passphrase="`cat $HOSTING_INFO_DIR/release-private.password`" \
80-
-DrepositoryId=sonatype-nexus-staging
81-
```
82-
(You must have a file at `~/.m2/settings.xml` that lists [a user token](https://central.sonatype.org/publish/generate-token/) and password for server `sonatype-nexus-staging`. )
72+
Update the `version` block in `javaparser-core/cfMavenCentral.xml` to be the same as the
73+
JavaParser version plus `-SNAPSHOT`. Run the following in `javaparser-core`
74+
```sh
75+
export STUBPARSER=stubparser-3.25.5
76+
export HOSTING_INFO_DIR=/projects/swlab1/checker-framework/hosting-info
77+
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/content/repositories/snapshots/ \
78+
-DpomFile=cfMavenCentral.xml -Dfile=target/$STUBPARSER.jar\
79+
-Dgpg.keyname=checker-framework-dev@googlegroups.com \
80+
-Dgpg.passphrase="`cat $HOSTING_INFO_DIR/release-private.password`" \
81+
-DrepositoryId=sonatype-nexus-staging
82+
```
83+
(You must have a file at `~/.m2/settings.xml` that lists [a user token](https://central.sonatype.org/publish/generate-token/) and password for server `sonatype-nexus-staging`. )
8384

8485
9. Update the stubparser version number in the Checker Framework. Create
85-
a branch with the same name as your StubParser branch. In
86-
`checker-framework/framework/build.gradle`, update `stubparserJar`.
86+
a branch with the same name as your StubParser branch. In
87+
`checker-framework/framework/build.gradle`, update `stubparserJar`.
8788
10. Run Checker Framework tests (`./gradlew build`), using your StubParser branch.
8889
If any tests fail, fix them before continuing.
8990
11. Commit and push your changes to Checker Framework.
9091
12. Once the Azure tests pass, release the Stubparser:
9192

92-
Delete `-SNAPSHOT` from the version in `javaparser-core/cfMavenCentral.xml`.
93-
94-
```
95-
../mvnw source:jar && \
96-
../mvnw javadoc:javadoc && (cd target/reports/apidocs && jar -c -f ../../$STUBPARSER-javadoc.jar com)
97-
98-
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
99-
-DpomFile=cfMavenCentral.xml -Dfile=target/$STUBPARSER.jar \
100-
-Dgpg.keyname=checker-framework-dev@googlegroups.com \
101-
-Dgpg.passphrase="`cat $HOSTING_INFO_DIR/release-private.password`" \
102-
-DrepositoryId=sonatype-nexus-staging
103-
104-
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
105-
-DpomFile=cfMavenCentral.xml \
106-
-Dgpg.keyname=checker-framework-dev@googlegroups.com \
107-
-Dgpg.passphrase="`cat $HOSTING_INFO_DIR/release-private.password`" \
108-
-DrepositoryId=sonatype-nexus-staging \
109-
-Dclassifier=javadoc -Dfile=target/$STUBPARSER-javadoc.jar
110-
111-
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
112-
-DpomFile=cfMavenCentral.xml \
113-
-Dgpg.keyname=checker-framework-dev@googlegroups.com \
114-
-Dgpg.passphrase="`cat $HOSTING_INFO_DIR/release-private.password`" \
115-
-DrepositoryId=sonatype-nexus-staging \
116-
-Dclassifier=sources -Dfile=target/$STUBPARSER-sources.jar
93+
Delete `-SNAPSHOT` from the version in `javaparser-core/cfMavenCentral.xml`.
11794

118-
```
95+
```sh
96+
../mvnw source:jar && \
97+
../mvnw javadoc:javadoc && (cd target/reports/apidocs && jar -c -f ../../$STUBPARSER-javadoc.jar com)
98+
99+
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
100+
-DpomFile=cfMavenCentral.xml -Dfile=target/$STUBPARSER.jar \
101+
-Dgpg.keyname=checker-framework-dev@googlegroups.com \
102+
-Dgpg.passphrase="`cat $HOSTING_INFO_DIR/release-private.password`" \
103+
-DrepositoryId=sonatype-nexus-staging
104+
105+
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
106+
-DpomFile=cfMavenCentral.xml \
107+
-Dgpg.keyname=checker-framework-dev@googlegroups.com \
108+
-Dgpg.passphrase="`cat $HOSTING_INFO_DIR/release-private.password`" \
109+
-DrepositoryId=sonatype-nexus-staging \
110+
-Dclassifier=javadoc -Dfile=target/$STUBPARSER-javadoc.jar
111+
112+
../mvnw gpg:sign-and-deploy-file -Durl=https://oss.sonatype.org/service/local/staging/deploy/maven2/ \
113+
-DpomFile=cfMavenCentral.xml \
114+
-Dgpg.keyname=checker-framework-dev@googlegroups.com \
115+
-Dgpg.passphrase="`cat $HOSTING_INFO_DIR/release-private.password`" \
116+
-DrepositoryId=sonatype-nexus-staging \
117+
-Dclassifier=sources -Dfile=target/$STUBPARSER-sources.jar
118+
```
119119

120-
Complete the release at https://oss.sonatype.org/#stagingRepositories.
120+
Complete the release at https://oss.sonatype.org/#stagingRepositories.
121121

122122
13. In the Checker Framework, remove `SNAPSHOT` in the StubParser version numbers.
123-
Commit and push your changes to Checker Framework.
123+
Commit and push your changes to Checker Framework.
124124

125125
14. Push commits to your fork of StubParser.
126-
```sh
127-
git push
128-
```
129-
GitHub Actions CI will not run for your branch.
126+
```sh
127+
git push
128+
```
129+
GitHub Actions CI will not run for your branch.
130130

131131
15. Create a [pull request to `typetools/stubparser`](https://github.com/typetools/stubparser).
132-
Give it a title like "Update to JavaParser 3.24.3".
133-
Do *not* squash-and-merge the pull request;
134-
you want to keep a history of what upstream commits were merged in.
132+
Give it a title like "Update to JavaParser 3.24.3".
133+
Do *not* squash-and-merge the pull request;
134+
you want to keep a history of what upstream commits were merged in.
135135

136136
16. Create a [pull request to `typetools/checker-framework`](https://github.com/typetools/checkerframework).
137-
Give it a title like "Update to StubParser 3.24.3".
137+
Give it a title like "Update to StubParser 3.24.3".
138138

139139
17. Merge both pull requests when both pass.
140140

0 commit comments

Comments
 (0)