Skip to content
This repository was archived by the owner on Dec 29, 2022. It is now read-only.

Commit 7d704c7

Browse files
committed
Release preparations
1 parent 8898831 commit 7d704c7

9 files changed

Lines changed: 132 additions & 19 deletions

File tree

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,11 @@ target
1212

1313
# Other
1414
/site/docs
15+
16+
# Credentials / Releasing
17+
service-account.json
18+
release.properties
19+
*.xml.releaseBackup
20+
*.xml.tag
21+
*.xml.next
22+

README.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,31 +58,56 @@ and [read our docs for more information about indexing your data](https://www.fi
5858
## Including GeoFire in your project Android/Java
5959

6060
In order to use GeoFire in your project, you need to [add the Firebase Android
61-
SDK](https://firebase.google.com/docs/android/setup). After that you can include
62-
GeoFire with one of the choices below.
61+
SDK](https://firebase.google.com/docs/android/setup). After that you can include GeoFire with one of the choices below.
62+
63+
Note that after version `1.1.1` the artifact `com.firebase:geofire` is no
64+
longer updated and has been replaced by the separate Android and Java
65+
artifacts as described below.
6366

6467
### Gradle
6568

66-
Add a dependency for GeoFire to your `gradle.build` file:
69+
Add a dependency for GeoFire to your `gradle.build` file.
70+
71+
For Android applications:
6772

6873
```groovy
6974
dependencies {
70-
compile 'com.firebase:geofire:2.0.0'
75+
compile 'com.firebase:geofire-android:2.0.0'
7176
}
7277
```
7378

79+
For non-Android Java applications:
80+
81+
```groovy
82+
dependencies {
83+
compile 'com.firebase:geofire-java:2.0.0'
84+
}
85+
86+
```
87+
7488
### Maven
7589

76-
GeoFire also works with Maven:
90+
GeoFire also works with Maven.
91+
92+
For Android applications:
7793

7894
```xml
7995
<dependency>
8096
<groupId>com.firebase</groupId>
81-
<artifactId>geofire</artifactId>
97+
<artifactId>geofire-android</artifactId>
8298
<version>2.0.0</version>
8399
</dependency>
84100
```
85101

102+
For non-Android Java applications:
103+
104+
```xml
105+
<dependency>
106+
<groupId>com.firebase</groupId>
107+
<artifactId>geofire-java</artifactId>
108+
<version>2.0.0</version>
109+
</dependency>
110+
```
86111

87112
### Jar-File
88113

@@ -257,10 +282,11 @@ the query to the new visible map area after a user scrolls.
257282

258283

259284
## Deployment
260-
- log onto the build box
261-
- checkout and update the master branch
262-
- `./release.sh` to build the client and update maven
263-
- close/release the repository from sonatype
285+
- In your local environment set `$BINTRAY_USER` and `$BINTRAY_KEY` to your
286+
Bintray.com username and API key.
287+
- Checkout and update the master branch.
288+
- Run `./release.sh` to build and deploy.
289+
- On bintray.com, publish the draft artifacts.
264290
- Update [firebase-versions](https://github.com/firebase/firebase-clients/blob/master/versions/firebase-versions.json) with the changelog from this version
265291
- tweet the release
266292

android/pom.xml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@
3434
<properties>
3535
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3636
</properties>
37+
38+
<distributionManagement>
39+
<repository>
40+
<id>geofire</id>
41+
<url>https://api.bintray.com/maven/firebase/geofire/geofire-android</url>
42+
</repository>
43+
</distributionManagement>
44+
3745
<build>
3846
<sourceDirectory>../src/main/java</sourceDirectory>
3947
<plugins>
@@ -45,6 +53,7 @@
4553
</plugin>
4654
</plugins>
4755
</build>
56+
4857
<repositories>
4958
<repository>
5059
<id>google-extras</id>

create-docs.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@ mvn javadoc:javadoc
99

1010
echo "Renaming output folder"
1111
rm -rf site/docs
12+
mkdir -p target/site/apidocs
1213
mv target/site/apidocs site/docs
1314
popd

java/pom.xml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,19 @@
3434
<properties>
3535
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
3636
</properties>
37+
38+
<distributionManagement>
39+
<repository>
40+
<id>geofire</id>
41+
<url>https://api.bintray.com/maven/firebase/geofire/geofire-java</url>
42+
</repository>
43+
</distributionManagement>
44+
3745
<build>
38-
<!-- Plugins inherited -->
46+
<sourceDirectory>../src/main/java</sourceDirectory>
47+
<testSourceDirectory>../src/test/java</testSourceDirectory>
3948
</build>
49+
4050
<dependencies>
4151
<dependency>
4252
<groupId>com.google.firebase</groupId>

pom.xml

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,7 @@
1919
<developerConnection>scm:git:git@github.com:firebase/geofire-java.git</developerConnection>
2020
<url>https://github.com/firebase/geofire-java</url>
2121
</scm>
22-
<parent>
23-
<groupId>org.sonatype.oss</groupId>
24-
<artifactId>oss-parent</artifactId>
25-
<version>7</version>
26-
</parent>
22+
2723
<licenses>
2824
<license>
2925
<name>MIT</name>
@@ -39,7 +35,25 @@
3935
<module>java</module>
4036
</modules>
4137

38+
<distributionManagement>
39+
<repository>
40+
<id>geofire</id>
41+
<url>https://api.bintray.com/maven/firebase/geofire/geofire</url>
42+
</repository>
43+
</distributionManagement>
44+
4245
<build>
46+
<!--
47+
Add -Dbuildtime.output.log=true to profile maven task times.
48+
-->
49+
<extensions>
50+
<extension>
51+
<groupId>co.leantechniques</groupId>
52+
<artifactId>maven-buildtime-extension</artifactId>
53+
<version>2.0.3</version>
54+
</extension>
55+
</extensions>
56+
4357
<plugins>
4458
<plugin>
4559
<groupId>org.apache.maven.plugins</groupId>
@@ -84,6 +98,7 @@
8498
</plugin>
8599
</plugins>
86100
</build>
101+
87102
<dependencies>
88103
<!-- Dependencies defined in child POMs -->
89104
</dependencies>

release.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ fi
4949
###################
5050
read -p "Next, make sure this repo is clean and up to date. We will be kicking off a deploy to maven." DERP
5151
mvn clean
52-
mvn release:clean release:prepare release:perform -Dtag=v$VERSION
52+
mvn -s settings.xml release:clean release:prepare release:perform -Darguments="-DskipTests" -Dtag=v$VERSION
5353

5454
if [[ $? -ne 0 ]]; then
5555
echo "error: Error building and releasing to maven."

settings.xml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<?xml version='1.0' encoding='UTF-8'?>
2+
<settings
3+
xsi:schemaLocation='http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd'
4+
xmlns='http://maven.apache.org/SETTINGS/1.0.0'
5+
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'>
6+
7+
<servers>
8+
<server>
9+
<id>geofire</id>
10+
<username>${env.BINTRAY_USER}</username>
11+
<password>${env.BINTRAY_KEY}</password>
12+
</server>
13+
</servers>
14+
15+
<profiles>
16+
<profile>
17+
<repositories>
18+
<repository>
19+
<snapshots>
20+
<enabled>false</enabled>
21+
</snapshots>
22+
<id>central</id>
23+
<name>bintray</name>
24+
<url>http://jcenter.bintray.com</url>
25+
</repository>
26+
</repositories>
27+
<pluginRepositories>
28+
<pluginRepository>
29+
<snapshots>
30+
<enabled>false</enabled>
31+
</snapshots>
32+
<id>central</id>
33+
<name>bintray-plugins</name>
34+
<url>http://jcenter.bintray.com</url>
35+
</pluginRepository>
36+
</pluginRepositories>
37+
<id>bintray</id>
38+
</profile>
39+
</profiles>
40+
41+
<activeProfiles>
42+
<activeProfile>bintray</activeProfile>
43+
</activeProfiles>
44+
</settings>

src/test/java/com/firebase/geofire/RealDataTest.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@
1717

1818
public class RealDataTest {
1919

20-
private static final String DATABASE_URL = "https://databaseName.firebaseio.com/";
21-
private static final String SERVICE_ACCOUNT_CREDENTIALS = "path/to/serviceAccountCredentials.json";
20+
private static final String DATABASE_URL = "https://geofiretest-8d811.firebaseio.com/";
21+
private static final String SERVICE_ACCOUNT_CREDENTIALS = "service-account.json";
2222

2323
DatabaseReference databaseReference;
2424

0 commit comments

Comments
 (0)