Skip to content

Commit

Permalink
Remove enunciate REST API documentation generator
Browse files Browse the repository at this point in the history
  • Loading branch information
leonardehrenfried committed Sep 13, 2023
1 parent 9dbe5c5 commit 3921232
Show file tree
Hide file tree
Showing 3 changed files with 0 additions and 65 deletions.
12 changes: 0 additions & 12 deletions docs/ReleaseChecklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,18 +48,6 @@ manually is more tedious, but keeps eyes on each step and is less prone to failu
* You can also use the `package` goal instead of the `install` goal to avoid signing if you
don't have the GPG certificate installed.
* All tests should pass
* Run `MAVEN_OPTS="--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED" mvn com.webcohesion.enunciate:enunciate-maven-plugin:docs`
* This build will also create Enunciate API docs and Javadoc with the correct non-snapshot
version number
* Deploy the documentation to AWS S3
* You have to do this right after the test release build to ensure the right version number in
the docs
* You will need AWSCLI tools (`sudo pip install -U awscli`)
* You will need AWS credentials with write access to the bucket `s3://dev.opentripplanner.org`
* `aws s3 cp --recursive target/site/apidocs s3://dev.opentripplanner.org/javadoc/x.y.z --acl public-read`
* `aws s3 cp --recursive target/site/enunciate/apidocs s3://dev.opentripplanner.org/apidoc/x.y.z --acl public-read`
* Check that docs are readable and show the correct version via
the [development documentation landing page](http://dev.opentripplanner.org).
* Finally, if everything looks good, tag and push this release to make it official
* `git tag -a vX.Y.Z -m "release X.Y.Z"`
* `git push origin vX.Y.Z`
Expand Down
29 changes: 0 additions & 29 deletions enunciate.xml

This file was deleted.

24 changes: 0 additions & 24 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -182,23 +182,6 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>com.webcohesion.enunciate</groupId>
<artifactId>enunciate-maven-plugin</artifactId>
<version>2.15.1</version>
<executions>
<execution>
<!-- override default binding to process-sources phase (enunciate generates web services). -->
<phase>site</phase>
<goals>
<goal>docs</goal>
</goals>
</execution>
</executions>
<configuration>
<docsDir>${project.build.directory}/site/enunciate</docsDir>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
Expand Down Expand Up @@ -256,13 +239,6 @@
</execution>
</executions>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>3.12.1</version>
</plugin>

<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
Expand Down

0 comments on commit 3921232

Please sign in to comment.