Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Release instructions, changes to javadoc generation

  • Loading branch information...
commit 3693da1dd27a7426b64af7f87e1ba6efc1415f82 1 parent 07a99ab
@jberkel jberkel authored
Showing with 40 additions and 6 deletions.
  1. +1 −1  README.md
  2. +19 −0 RELEASE.md
  3. +13 −0 build.gradle
  4. +7 −5 update_javadoc.sh
View
2  README.md
@@ -159,7 +159,7 @@ See LICENSE for details.
[Apache HttpClient]: http://hc.apache.org/httpcomponents-client-ga/
[HttpMime]: http://hc.apache.org/httpcomponents-client-ga/httpmime
[json-java]: http://json.org/java/
-[javadoc]: http://soundcloud.github.com/java-api-wrapper/javadoc/com/soundcloud/api/package-summary.html
+[javadoc]: http://soundcloud.github.com/java-api-wrapper/javadoc/1.0.0/com/soundcloud/api/package-summary.html
[soundcloudapi-java]: http://code.google.com/p/soundcloudapi-java/
[soundcloudapi-java-annouce]: http://blog.soundcloud.com/2010/01/08/java-wrapper/
[CreateWrapper]: https://github.com/soundcloud/java-api-wrapper/blob/master/src/examples/java/com/soundcloud/api/examples/CreateWrapper.java
View
19 RELEASE.md
@@ -0,0 +1,19 @@
+#How to release a new version of the wrapper
+
+Bump version constants in
+
+ * build.gradle
+ * src/main/java/com/soundcloud/api/package-info.java
+ * src/main/java/com/soundcloud/api/CloudAPI.java
+
+Regenerate + publish javadoc:
+
+ $ ./update_javadoc.sh
+
+Regenerate pom.xml
+
+ $ gradle writePom
+
+Upload to maven
+
+ $ gradle uploadArchives
View
13 build.gradle
@@ -74,6 +74,19 @@ uploadArchives {
<artifactId>maven-compiler-plugin</artifactId>
<version>2.3</version>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-gpg-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>sign-artifacts</id>
+ <phase>verify</phase>
+ <goals>
+ <goal>sign</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
</plugins>
</build>
</project>
View
12 update_javadoc.sh
@@ -5,17 +5,19 @@
## by regenerating them via gradle and pushing them back to gh-pages
DOCS=docs
+JAVADOCS=build/javadoc
set -e
trap "rm -rf $PWD/$DOCS" EXIT
-rm -rf $DOCS
+rm -rf $DOCS $JAVADOCS
git clone git@github.com:soundcloud/java-api-wrapper.git $DOCS -b gh-pages
-gradle javadoc
-rsync -f 'exclude .git' -r --delete build/docs/ $DOCS
+gradle doc
+VERSION=$(basename $JAVADOCS/*)
+rsync -f 'exclude .git' -r --delete $JAVADOCS/$VERSION $DOCS/javadoc
cd $DOCS
-git commit -m 'javadoc update' -a --allow-empty
+git commit -m "javadocs for $VERSION" -a --allow-empty
git add .
-git commit --amend -a -m 'javadoc update' --allow-empty
+git commit --amend -a -m "javadocs for $VERSION" --allow-empty
git diff origin/gh-pages --summary --exit-code || git push origin gh-pages
Please sign in to comment.
Something went wrong with that request. Please try again.